TestConnection - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TestConnection

Tests the connection between the replication instance and the endpoint.

Request Syntax

{ "EndpointArn": "string", "ReplicationInstanceArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EndpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Type: String

Required: Yes

ReplicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

Type: String

Required: Yes

Response Syntax

{ "Connection": { "EndpointArn": "string", "EndpointIdentifier": "string", "LastFailureMessage": "string", "ReplicationInstanceArn": "string", "ReplicationInstanceIdentifier": "string", "Status": "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.

Connection

The connection tested.

Type: Connection object

Errors

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

AccessDeniedFault

Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

Amazon DMS cannot access the KMS key.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

ResourceQuotaExceededFault

The quota for this resource quota has been exceeded.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of TestConnection.

Sample Request

POST / HTTP/1.1 Host: dms.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user- agent;x-amz-date;x-amz-target;x-amzn- requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AmazonDMSv20160101.TestConnection { "ReplicationInstanceArn": "arn:aws:dms:us-east- 1:123456789012:rep:6USOU366XFJUWATDJGBCJS3VIQ", "EndpointArn": "arn:aws:dms:us-east- 1:123456789012:endpoint:WKBULDZKUDQZIHPOUUSEH34EMU" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "Connection":{ "Status":"testing", "ReplicationInstanceIdentifier":"akshay1", "EndpointArn":"arn:aws:dms:us-east- 1:123456789012:endpoint:WKBULDZKUDQZIHPOUUSEH34EMU", "EndpointIdentifier":"akshay", "ReplicationInstanceArn":"arn:aws:dms:us-east- 1:123456789012:rep:6USOU366XFJUWATDJGBCJS3VIQ" } }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: