Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDataSourceIntrospection

Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

Request Syntax


GET /v1/datasources/introspections/introspectionId?includeModelsSDL=includeModelsSDL&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

includeModelsSDL

A boolean flag that determines whether SDL should be generated for introspected types. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

introspectionId

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

Required: Yes

maxResults

The maximum number of introspected types that will be returned in a single response.

Valid Range: Minimum value of 0. Maximum value of 25.

nextToken

Determines the number of types to be returned in a single response before paginating. This value is typically taken from nextToken value from the previous response.

Length Constraints: Minimum length of 1. Maximum length of 65536.

Pattern: [\S]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "introspectionId": "string",
   "introspectionResult": { 
      "models": [ 
         { 
            "fields": [ 
               { 
                  "length": number,
                  "name": "string",
                  "type": { 
                     "kind": "string",
                     "name": "string",
                     "type": "DataSourceIntrospectionModelFieldType",
                     "values": [ "string" ]
                  }
               }
            ],
            "indexes": [ 
               { 
                  "fields": [ "string" ],
                  "name": "string"
               }
            ],
            "name": "string",
            "primaryKey": { 
               "fields": [ "string" ],
               "name": "string"
            },
            "sdl": "string"
         }
      ],
      "nextToken": "string"
   },
   "introspectionStatus": "string",
   "introspectionStatusDetail": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

introspectionId

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

Type: String

introspectionResult

The DataSourceIntrospectionResult object data.

Type: DataSourceIntrospectionResult object

introspectionStatus

The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

Type: String

Valid Values: PROCESSING | FAILED | SUCCESS

introspectionStatusDetail

The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404