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.

Implementation for accessing DatabaseMigrationService AWS Database Migration Service

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

For more information about AWS DMS, see the AWS DMS user guide at What Is AWS Database Migration Service?

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.DatabaseMigrationService.AmazonDatabaseMigrationServiceClient

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

Syntax

C#
public class AmazonDatabaseMigrationServiceClient : AmazonServiceClient
         IAmazonDatabaseMigrationService, IAmazonService, IDisposable

The AmazonDatabaseMigrationServiceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonDatabaseMigrationServiceClient()

Constructs AmazonDatabaseMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonDatabaseMigrationServiceClient(RegionEndpoint)

Constructs AmazonDatabaseMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonDatabaseMigrationServiceClient(AmazonDatabaseMigrationServiceConfig)

Constructs AmazonDatabaseMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonDatabaseMigrationServiceClient(AWSCredentials)

Constructs AmazonDatabaseMigrationServiceClient with AWS Credentials

Public Method AmazonDatabaseMigrationServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonDatabaseMigrationServiceClient with AWS Credentials

Public Method AmazonDatabaseMigrationServiceClient(AWSCredentials, AmazonDatabaseMigrationServiceConfig)

Constructs AmazonDatabaseMigrationServiceClient with AWS Credentials and an AmazonDatabaseMigrationServiceClient Configuration object.

Public Method AmazonDatabaseMigrationServiceClient(string, string)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDatabaseMigrationServiceClient(string, string, RegionEndpoint)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDatabaseMigrationServiceClient(string, string, AmazonDatabaseMigrationServiceConfig)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDatabaseMigrationServiceClient Configuration object.

Public Method AmazonDatabaseMigrationServiceClient(string, string, string)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDatabaseMigrationServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDatabaseMigrationServiceClient(string, string, string, AmazonDatabaseMigrationServiceConfig)

Constructs AmazonDatabaseMigrationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDatabaseMigrationServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTagsToResource(AddTagsToResourceRequest)

Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToResource operation.

Public Method CreateEndpoint(CreateEndpointRequest)

Creates an endpoint using the provided settings.

Public Method CreateEndpointAsync(CreateEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEndpoint operation.

Public Method CreateEventSubscription(CreateEventSubscriptionRequest)

Creates an AWS DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account.

For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database MIgration Service User Guide.

Public Method CreateEventSubscriptionAsync(CreateEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEventSubscription operation.

Public Method CreateReplicationInstance(CreateReplicationInstanceRequest)

Creates the replication instance using the specified parameters.

Public Method CreateReplicationInstanceAsync(CreateReplicationInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReplicationInstance operation.

Public Method CreateReplicationSubnetGroup(CreateReplicationSubnetGroupRequest)

Creates a replication subnet group given a list of the subnet IDs in a VPC.

Public Method CreateReplicationSubnetGroupAsync(CreateReplicationSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReplicationSubnetGroup operation.

Public Method CreateReplicationTask(CreateReplicationTaskRequest)

Creates a replication task using the specified parameters.

Public Method CreateReplicationTaskAsync(CreateReplicationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReplicationTask operation.

Public Method DeleteCertificate(DeleteCertificateRequest)

Deletes the specified certificate.

Public Method DeleteCertificateAsync(DeleteCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCertificate operation.

Public Method DeleteEndpoint(DeleteEndpointRequest)

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

Public Method DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEndpoint operation.

Public Method DeleteEventSubscription(DeleteEventSubscriptionRequest)

Deletes an AWS DMS event subscription.

Public Method DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEventSubscription operation.

Public Method DeleteReplicationInstance(DeleteReplicationInstanceRequest)

Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.

Public Method DeleteReplicationInstanceAsync(DeleteReplicationInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReplicationInstance operation.

Public Method DeleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest)

Deletes a subnet group.

Public Method DeleteReplicationSubnetGroupAsync(DeleteReplicationSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReplicationSubnetGroup operation.

Public Method DeleteReplicationTask(DeleteReplicationTaskRequest)

Deletes the specified replication task.

Public Method DeleteReplicationTaskAsync(DeleteReplicationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReplicationTask operation.

Public Method DescribeAccountAttributes(DescribeAccountAttributesRequest)

Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

Public Method DescribeAccountAttributesAsync(DescribeAccountAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccountAttributes operation.

Public Method DescribeCertificates(DescribeCertificatesRequest)

Provides a description of the certificate.

Public Method DescribeCertificatesAsync(DescribeCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCertificates operation.

Public Method DescribeConnections(DescribeConnectionsRequest)

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

Public Method DescribeConnectionsAsync(DescribeConnectionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConnections operation.

Public Method DescribeEndpoints(DescribeEndpointsRequest)

Returns information about the endpoints for your account in the current region.

Public Method DescribeEndpointsAsync(DescribeEndpointsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpoints operation.

Public Method DescribeEndpointTypes(DescribeEndpointTypesRequest)

Returns information about the type of endpoints available.

Public Method DescribeEndpointTypesAsync(DescribeEndpointTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpointTypes operation.

Public Method DescribeEventCategories(DescribeEventCategoriesRequest)

Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.

Public Method DescribeEventCategoriesAsync(DescribeEventCategoriesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventCategories operation.

Public Method DescribeEvents(DescribeEventsRequest)

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications .

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEvents operation.

Public Method DescribeEventSubscriptions(DescribeEventSubscriptionsRequest)

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

Public Method DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventSubscriptions operation.

Public Method DescribeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest)

Returns information about the replication instance types that can be created in the specified region.

Public Method DescribeOrderableReplicationInstancesAsync(DescribeOrderableReplicationInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOrderableReplicationInstances operation.

Public Method DescribeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest)

Returns the status of the RefreshSchemas operation.

Public Method DescribeRefreshSchemasStatusAsync(DescribeRefreshSchemasStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRefreshSchemasStatus operation.

Public Method DescribeReplicationInstances(DescribeReplicationInstancesRequest)

Returns information about replication instances for your account in the current region.

Public Method DescribeReplicationInstancesAsync(DescribeReplicationInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReplicationInstances operation.

Public Method DescribeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest)

Returns information about the replication subnet groups.

Public Method DescribeReplicationSubnetGroupsAsync(DescribeReplicationSubnetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReplicationSubnetGroups operation.

Public Method DescribeReplicationTasks(DescribeReplicationTasksRequest)

Returns information about replication tasks for your account in the current region.

Public Method DescribeReplicationTasksAsync(DescribeReplicationTasksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReplicationTasks operation.

Public Method DescribeSchemas(DescribeSchemasRequest)

Returns information about the schema for the specified endpoint.

Public Method DescribeSchemasAsync(DescribeSchemasRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSchemas operation.

Public Method DescribeTableStatistics(DescribeTableStatisticsRequest)

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Public Method DescribeTableStatisticsAsync(DescribeTableStatisticsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTableStatistics operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ImportCertificate(ImportCertificateRequest)

Uploads the specified certificate.

Public Method ImportCertificateAsync(ImportCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the ImportCertificate operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags for an AWS DMS resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method ModifyEndpoint(ModifyEndpointRequest)

Modifies the specified endpoint.

Public Method ModifyEndpointAsync(ModifyEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyEndpoint operation.

Public Method ModifyEventSubscription(ModifyEventSubscriptionRequest)

Modifies an existing AWS DMS event notification subscription.

Public Method ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyEventSubscription operation.

Public Method ModifyReplicationInstance(ModifyReplicationInstanceRequest)

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

Public Method ModifyReplicationInstanceAsync(ModifyReplicationInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyReplicationInstance operation.

Public Method ModifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest)

Modifies the settings for the specified replication subnet group.

Public Method ModifyReplicationSubnetGroupAsync(ModifyReplicationSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyReplicationSubnetGroup operation.

Public Method ModifyReplicationTask(ModifyReplicationTaskRequest)

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks

Public Method ModifyReplicationTaskAsync(ModifyReplicationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyReplicationTask operation.

Public Method RefreshSchemas(RefreshSchemasRequest)

Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.

Public Method RefreshSchemasAsync(RefreshSchemasRequest, CancellationToken)

Initiates the asynchronous execution of the RefreshSchemas operation.

Public Method ReloadTables(ReloadTablesRequest)

Reloads the target database table with the source data.

Public Method ReloadTablesAsync(ReloadTablesRequest, CancellationToken)

Initiates the asynchronous execution of the ReloadTables operation.

Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest)

Removes metadata tags from a DMS resource.

Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromResource operation.

Public Method StartReplicationTask(StartReplicationTaskRequest)

Starts the replication task.

For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks

Public Method StartReplicationTaskAsync(StartReplicationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StartReplicationTask operation.

Public Method StopReplicationTask(StopReplicationTaskRequest)

Stops the replication task.

Public Method StopReplicationTaskAsync(StopReplicationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StopReplicationTask operation.

Public Method TestConnection(TestConnectionRequest)

Tests the connection between the replication instance and the endpoint.

Public Method TestConnectionAsync(TestConnectionRequest, CancellationToken)

Initiates the asynchronous execution of the TestConnection operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms