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

StartDataSourceIntrospection

Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

Request Syntax


POST /v1/datasources/introspections HTTP/1.1
Content-type: application/json

{
   "rdsDataApiConfig": { 
      "databaseName": "string",
      "resourceArn": "string",
      "secretArn": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

rdsDataApiConfig

The rdsDataApiConfig object data.

Type: RdsDataApiConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "introspectionId": "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

introspectionStatus

The status of the introspection during creation. By default, when a new instrospection has been created, 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

UnauthorizedException

You aren't authorized to perform this operation.

HTTP Status Code: 401