AmazonDatabaseMigrationServiceClient.TestConnection Method (TestConnectionRequest)

Tests the connection between the replication instance and the endpoint.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to TestConnectionAsync.

Namespace: Amazon.DatabaseMigrationService
Assembly: AWSSDK.DatabaseMigrationService.dll
Version: 3.x.y.z

Syntax

public virtual TestConnectionResponse TestConnection(
         TestConnectionRequest request
)

Parameters

request: Type: Amazon.DatabaseMigrationService.Model.TestConnectionRequest

Container for the necessary parameters to execute the TestConnection service method.

Return Value

Type: TestConnectionResponse

The response from the TestConnection service method, as returned by DatabaseMigrationService.

Exceptions

Exception	Condition
AccessDeniedException	DMS was denied access to the endpoint. Check that the role is correctly configured.
InvalidResourceStateException	The resource is in a state that prevents it from being used for database migration.
KMSKeyNotAccessibleException	DMS cannot access the KMS key.
ResourceNotFoundException	The resource could not be found.
ResourceQuotaExceededException	The quota for this resource quota has been exceeded.

Examples

Tests the connection between the replication instance and the endpoint.

Test conection


var client = new AmazonDatabaseMigrationServiceClient();
var response = client.TestConnection(new TestConnectionRequest 
{
    EndpointArn = "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
    ReplicationInstanceArn = "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
});

Connection connection = response.Connection;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonDatabaseMigrationServiceClient.TestConnection (TestConnectionRequest)

Method