AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface DatabaseMigrationClient extends AutoCloseable
builder() method.
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?
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration
task.
|
static DatabaseMigrationClientBuilder |
builder() |
Create a builder that can be used to configure and create a
DatabaseMigrationClient. |
static DatabaseMigrationClient |
create() |
Create a
DatabaseMigrationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateEndpointResponse |
createEndpoint(CreateEndpointRequest createEndpointRequest) |
Creates an endpoint using the provided settings.
|
default CreateEventSubscriptionResponse |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) |
Creates an AWS DMS event notification subscription.
|
default CreateReplicationInstanceResponse |
createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest) |
Creates the replication instance using the specified parameters.
|
default CreateReplicationSubnetGroupResponse |
createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest) |
Creates a replication subnet group given a list of the subnet IDs in a VPC.
|
default CreateReplicationTaskResponse |
createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest) |
Creates a replication task using the specified parameters.
|
default DeleteCertificateResponse |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) |
Deletes the specified certificate.
|
default DeleteEndpointResponse |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) |
Deletes the specified endpoint.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) |
Deletes an AWS DMS event subscription.
|
default DeleteReplicationInstanceResponse |
deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest) |
Deletes the specified replication instance.
|
default DeleteReplicationSubnetGroupResponse |
deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest) |
Deletes a subnet group.
|
default DeleteReplicationTaskResponse |
deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest) |
Deletes the specified replication task.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) |
Lists all of the AWS DMS attributes for a customer account.
|
default DescribeCertificatesResponse |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) |
Provides a description of the certificate.
|
default DescribeConnectionsResponse |
describeConnections(DescribeConnectionsRequest describeConnectionsRequest) |
Describes the status of the connections that have been made between the replication instance and an endpoint.
|
default DescribeEndpointsResponse |
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) |
Returns information about the endpoints for your account in the current region.
|
default DescribeEndpointTypesResponse |
describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest) |
Returns information about the type of endpoints available.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) |
Lists categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest) |
Lists events for a given source identifier and source type.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) |
Lists all the event subscriptions for a customer account.
|
default DescribeOrderableReplicationInstancesResponse |
describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest) |
Returns information about the replication instance types that can be created in the specified region.
|
default DescribeRefreshSchemasStatusResponse |
describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest) |
Returns the status of the RefreshSchemas operation.
|
default DescribeReplicationInstancesResponse |
describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest) |
Returns information about replication instances for your account in the current region.
|
default DescribeReplicationSubnetGroupsResponse |
describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest) |
Returns information about the replication subnet groups.
|
default DescribeReplicationTasksResponse |
describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest) |
Returns information about replication tasks for your account in the current region.
|
default DescribeSchemasResponse |
describeSchemas(DescribeSchemasRequest describeSchemasRequest) |
Returns information about the schema for the specified endpoint.
|
default DescribeTableStatisticsResponse |
describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest) |
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and
rows deleted.
|
default ImportCertificateResponse |
importCertificate(ImportCertificateRequest importCertificateRequest) |
Uploads the specified certificate.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Lists all tags for an AWS DMS resource.
|
default ModifyEndpointResponse |
modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest) |
Modifies the specified endpoint.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) |
Modifies an existing AWS DMS event notification subscription.
|
default ModifyReplicationInstanceResponse |
modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest) |
Modifies the replication instance to apply new settings.
|
default ModifyReplicationSubnetGroupResponse |
modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest) |
Modifies the settings for the specified replication subnet group.
|
default ModifyReplicationTaskResponse |
modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest) |
Modifies the specified replication task.
|
default RefreshSchemasResponse |
refreshSchemas(RefreshSchemasRequest refreshSchemasRequest) |
Populates the schema for the specified endpoint.
|
default ReloadTablesResponse |
reloadTables(ReloadTablesRequest reloadTablesRequest) |
Reloads the target database table with the source data.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes metadata tags from a DMS resource.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartReplicationTaskResponse |
startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest) |
Starts the replication task.
|
default StopReplicationTaskResponse |
stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest) |
Stops the replication task.
|
default TestConnectionResponse |
testConnection(TestConnectionRequest testConnectionRequest) |
Tests the connection between the replication instance and the endpoint.
|
closestatic final String SERVICE_NAME
static DatabaseMigrationClient create()
DatabaseMigrationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DatabaseMigrationClientBuilder builder()
DatabaseMigrationClient.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
addTagsToResourceRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws KMSKeyNotAccessibleException, ResourceAlreadyExistsException, ResourceQuotaExceededException, InvalidResourceStateException, ResourceNotFoundException, AccessDeniedException, SdkBaseException, SdkClientException, DatabaseMigrationException
Creates an endpoint using the provided settings.
createEndpointRequest - KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.ResourceAlreadyExistsException - The resource you are attempting to create already exists.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.AccessDeniedException - AWS DMS was denied access to the endpoint.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws ResourceQuotaExceededException, ResourceAlreadyExistsException, SNSInvalidTopicException, SNSNoAuthorizationException, ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
createEventSubscriptionRequest - ResourceQuotaExceededException - The quota for this resource quota has been exceeded.ResourceAlreadyExistsException - The resource you are attempting to create already exists.SNSInvalidTopicException - The SNS topic is invalid.SNSNoAuthorizationException - You are not authorized for the SNS subscription.ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateReplicationInstanceResponse createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest) throws AccessDeniedException, ResourceAlreadyExistsException, InsufficientResourceCapacityException, ResourceQuotaExceededException, StorageQuotaExceededException, ResourceNotFoundException, ReplicationSubnetGroupDoesNotCoverEnoughAZsException, InvalidResourceStateException, InvalidSubnetException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, DatabaseMigrationException
Creates the replication instance using the specified parameters.
createReplicationInstanceRequest - AccessDeniedException - AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException - The resource you are attempting to create already exists.InsufficientResourceCapacityException - There are not enough resources allocated to the database migration.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.StorageQuotaExceededException - The storage quota has been exceeded.ResourceNotFoundException - The resource could not be found.ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.InvalidSubnetException - The subnet provided is invalid.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateReplicationSubnetGroupResponse createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest) throws AccessDeniedException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceQuotaExceededException, ReplicationSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, SdkBaseException, SdkClientException, DatabaseMigrationException
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationSubnetGroupRequest - AccessDeniedException - AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException - The resource you are attempting to create already exists.ResourceNotFoundException - The resource could not be found.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidSubnetException - The subnet provided is invalid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateReplicationTaskResponse createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest) throws AccessDeniedException, InvalidResourceStateException, ResourceAlreadyExistsException, ResourceNotFoundException, KMSKeyNotAccessibleException, ResourceQuotaExceededException, SdkBaseException, SdkClientException, DatabaseMigrationException
Creates a replication task using the specified parameters.
createReplicationTaskRequest - AccessDeniedException - AWS DMS was denied access to the endpoint.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceAlreadyExistsException - The resource you are attempting to create already exists.ResourceNotFoundException - The resource could not be found.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes the specified certificate.
deleteCertificateRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpointRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes an AWS DMS event subscription.
deleteEventSubscriptionRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteReplicationInstanceResponse deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest) throws InvalidResourceStateException, ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
deleteReplicationInstanceRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteReplicationSubnetGroupResponse deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest) throws InvalidResourceStateException, ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes a subnet group.
deleteReplicationSubnetGroupRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteReplicationTaskResponse deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Deletes the specified replication task.
deleteReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws SdkBaseException, SdkClientException, DatabaseMigrationException
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.
describeAccountAttributesRequest - SdkBaseExceptionSdkClientExceptionDatabaseMigrationExceptiondefault DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Provides a description of the certificate.
describeCertificatesRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeConnectionsResponse describeConnections(DescribeConnectionsRequest describeConnectionsRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
describeConnectionsRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEndpointTypesResponse describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest) throws SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about the type of endpoints available.
describeEndpointTypesRequest - SdkBaseExceptionSdkClientExceptionDatabaseMigrationExceptiondefault DescribeEndpointsResponse describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about the endpoints for your account in the current region.
describeEndpointsRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws SdkBaseException, SdkClientException, DatabaseMigrationException
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.
describeEventCategoriesRequest - SdkBaseExceptionSdkClientExceptionDatabaseMigrationExceptiondefault DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
describeEventSubscriptionsRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws SdkBaseException, SdkClientException, DatabaseMigrationException
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 .
describeEventsRequest - SdkBaseExceptionSdkClientExceptionDatabaseMigrationExceptiondefault DescribeOrderableReplicationInstancesResponse describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest) throws SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstancesRequest - SdkBaseExceptionSdkClientExceptionDatabaseMigrationExceptiondefault DescribeRefreshSchemasStatusResponse describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest) throws InvalidResourceStateException, ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatusRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReplicationInstancesResponse describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about replication instances for your account in the current region.
describeReplicationInstancesRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReplicationSubnetGroupsResponse describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about the replication subnet groups.
describeReplicationSubnetGroupsRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReplicationTasksResponse describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about replication tasks for your account in the current region.
describeReplicationTasksRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSchemasResponse describeSchemas(DescribeSchemasRequest describeSchemasRequest) throws InvalidResourceStateException, ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns information about the schema for the specified endpoint.
describeSchemasRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTableStatisticsResponse describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
describeTableStatisticsRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ImportCertificateResponse importCertificate(ImportCertificateRequest importCertificateRequest) throws ResourceAlreadyExistsException, InvalidCertificateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Uploads the specified certificate.
importCertificateRequest - ResourceAlreadyExistsException - The resource you are attempting to create already exists.InvalidCertificateException - The certificate was not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Lists all tags for an AWS DMS resource.
listTagsForResourceRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyEndpointResponse modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest) throws InvalidResourceStateException, ResourceNotFoundException, ResourceAlreadyExistsException, KMSKeyNotAccessibleException, AccessDeniedException, SdkBaseException, SdkClientException, DatabaseMigrationException
Modifies the specified endpoint.
modifyEndpointRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.ResourceAlreadyExistsException - The resource you are attempting to create already exists.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.AccessDeniedException - AWS DMS was denied access to the endpoint.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws ResourceQuotaExceededException, ResourceNotFoundException, SNSInvalidTopicException, SNSNoAuthorizationException, SdkBaseException, SdkClientException, DatabaseMigrationException
Modifies an existing AWS DMS event notification subscription.
modifyEventSubscriptionRequest - ResourceQuotaExceededException - The quota for this resource quota has been exceeded.ResourceNotFoundException - The resource could not be found.SNSInvalidTopicException - The SNS topic is invalid.SNSNoAuthorizationException - You are not authorized for the SNS subscription.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyReplicationInstanceResponse modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest) throws InvalidResourceStateException, ResourceAlreadyExistsException, ResourceNotFoundException, InsufficientResourceCapacityException, StorageQuotaExceededException, UpgradeDependencyFailureException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
modifyReplicationInstanceRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceAlreadyExistsException - The resource you are attempting to create already exists.ResourceNotFoundException - The resource could not be found.InsufficientResourceCapacityException - There are not enough resources allocated to the database migration.StorageQuotaExceededException - The storage quota has been exceeded.UpgradeDependencyFailureException - An upgrade dependency is preventing the database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyReplicationSubnetGroupResponse modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest) throws AccessDeniedException, ResourceNotFoundException, ResourceQuotaExceededException, SubnetAlreadyInUseException, ReplicationSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, SdkBaseException, SdkClientException, DatabaseMigrationException
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroupRequest - AccessDeniedException - AWS DMS was denied access to the endpoint.ResourceNotFoundException - The resource could not be found.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.SubnetAlreadyInUseException - The specified subnet is already in use.ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidSubnetException - The subnet provided is invalid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyReplicationTaskResponse modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest) throws InvalidResourceStateException, ResourceNotFoundException, ResourceAlreadyExistsException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, DatabaseMigrationException
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
modifyReplicationTaskRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.ResourceAlreadyExistsException - The resource you are attempting to create already exists.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RefreshSchemasResponse refreshSchemas(RefreshSchemasRequest refreshSchemasRequest) throws InvalidResourceStateException, ResourceNotFoundException, KMSKeyNotAccessibleException, ResourceQuotaExceededException, SdkBaseException, SdkClientException, DatabaseMigrationException
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.
refreshSchemasRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReloadTablesResponse reloadTables(ReloadTablesRequest reloadTablesRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Reloads the target database table with the source data.
reloadTablesRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, DatabaseMigrationException
Removes metadata tags from a DMS resource.
removeTagsFromResourceRequest - ResourceNotFoundException - The resource could not be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartReplicationTaskResponse startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Starts the replication task.
For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks
startReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopReplicationTaskResponse stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest) throws ResourceNotFoundException, InvalidResourceStateException, SdkBaseException, SdkClientException, DatabaseMigrationException
Stops the replication task.
stopReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TestConnectionResponse testConnection(TestConnectionRequest testConnectionRequest) throws ResourceNotFoundException, InvalidResourceStateException, KMSKeyNotAccessibleException, ResourceQuotaExceededException, SdkBaseException, SdkClientException, DatabaseMigrationException
Tests the connection between the replication instance and the endpoint.
testConnectionRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException - AWS DMS cannot access the KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DatabaseMigrationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.