AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Tests the connection between the replication instance and the endpoint.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginTestConnection and EndTestConnection.

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

Syntax

C#
public abstract Task<TestConnectionResponse> TestConnectionAsync(
         TestConnectionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DatabaseMigrationService.Model.TestConnectionRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also