Package software.amazon.awssdk.services.databasemigration

Interface DatabaseMigrationAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface DatabaseMigrationAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. 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?

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddTagsToResourceResponse>	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.
static DatabaseMigrationAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a DatabaseMigrationAsyncClient.
static DatabaseMigrationAsyncClient	create()	Create a DatabaseMigrationAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateEndpointResponse>	createEndpoint(CreateEndpointRequest createEndpointRequest)	Creates an endpoint using the provided settings.
default CompletableFuture<CreateEventSubscriptionResponse>	createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)	Creates an AWS DMS event notification subscription.
default CompletableFuture<CreateReplicationInstanceResponse>	createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)	Creates the replication instance using the specified parameters.
default CompletableFuture<CreateReplicationSubnetGroupResponse>	createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)	Creates a replication subnet group given a list of the subnet IDs in a VPC.
default CompletableFuture<CreateReplicationTaskResponse>	createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)	Creates a replication task using the specified parameters.
default CompletableFuture<DeleteCertificateResponse>	deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)	Deletes the specified certificate.
default CompletableFuture<DeleteEndpointResponse>	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)	Deletes the specified endpoint.
default CompletableFuture<DeleteEventSubscriptionResponse>	deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)	Deletes an AWS DMS event subscription.
default CompletableFuture<DeleteReplicationInstanceResponse>	deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)	Deletes the specified replication instance.
default CompletableFuture<DeleteReplicationSubnetGroupResponse>	deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)	Deletes a subnet group.
default CompletableFuture<DeleteReplicationTaskResponse>	deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)	Deletes the specified replication task.
default CompletableFuture<DescribeAccountAttributesResponse>	describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)	Lists all of the AWS DMS attributes for a customer account.
default CompletableFuture<DescribeCertificatesResponse>	describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)	Provides a description of the certificate.
default CompletableFuture<DescribeConnectionsResponse>	describeConnections(DescribeConnectionsRequest describeConnectionsRequest)	Describes the status of the connections that have been made between the replication instance and an endpoint.
default CompletableFuture<DescribeEndpointsResponse>	describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)	Returns information about the endpoints for your account in the current region.
default CompletableFuture<DescribeEndpointTypesResponse>	describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)	Returns information about the type of endpoints available.
default CompletableFuture<DescribeEventCategoriesResponse>	describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)	Lists categories for all event source types, or, if specified, for a specified source type.
default CompletableFuture<DescribeEventsResponse>	describeEvents(DescribeEventsRequest describeEventsRequest)	Lists events for a given source identifier and source type.
default CompletableFuture<DescribeEventSubscriptionsResponse>	describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)	Lists all the event subscriptions for a customer account.
default CompletableFuture<DescribeOrderableReplicationInstancesResponse>	describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)	Returns information about the replication instance types that can be created in the specified region.
default CompletableFuture<DescribeRefreshSchemasStatusResponse>	describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)	Returns the status of the RefreshSchemas operation.
default CompletableFuture<DescribeReplicationInstancesResponse>	describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)	Returns information about replication instances for your account in the current region.
default CompletableFuture<DescribeReplicationSubnetGroupsResponse>	describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)	Returns information about the replication subnet groups.
default CompletableFuture<DescribeReplicationTasksResponse>	describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)	Returns information about replication tasks for your account in the current region.
default CompletableFuture<DescribeSchemasResponse>	describeSchemas(DescribeSchemasRequest describeSchemasRequest)	Returns information about the schema for the specified endpoint.
default CompletableFuture<DescribeTableStatisticsResponse>	describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)	Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
default CompletableFuture<ImportCertificateResponse>	importCertificate(ImportCertificateRequest importCertificateRequest)	Uploads the specified certificate.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags for an AWS DMS resource.
default CompletableFuture<ModifyEndpointResponse>	modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)	Modifies the specified endpoint.
default CompletableFuture<ModifyEventSubscriptionResponse>	modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)	Modifies an existing AWS DMS event notification subscription.
default CompletableFuture<ModifyReplicationInstanceResponse>	modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest)	Modifies the replication instance to apply new settings.
default CompletableFuture<ModifyReplicationSubnetGroupResponse>	modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)	Modifies the settings for the specified replication subnet group.
default CompletableFuture<ModifyReplicationTaskResponse>	modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest)	Modifies the specified replication task.
default CompletableFuture<RefreshSchemasResponse>	refreshSchemas(RefreshSchemasRequest refreshSchemasRequest)	Populates the schema for the specified endpoint.
default CompletableFuture<ReloadTablesResponse>	reloadTables(ReloadTablesRequest reloadTablesRequest)	Reloads the target database table with the source data.
default CompletableFuture<RemoveTagsFromResourceResponse>	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Removes metadata tags from a DMS resource.
default CompletableFuture<StartReplicationTaskResponse>	startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)	Starts the replication task.
default CompletableFuture<StopReplicationTaskResponse>	stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)	Stops the replication task.
default CompletableFuture<TestConnectionResponse>	testConnection(TestConnectionRequest testConnectionRequest)	Tests the connection between the replication instance and the endpoint.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static DatabaseMigrationAsyncClient create()

Create a DatabaseMigrationAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DatabaseMigrationAsyncClientBuilder builder()

Create a builder that can be used to configure and create a DatabaseMigrationAsyncClient.

addTagsToResource

default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest 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.

Parameters:

addTagsToResourceRequest -

Returns:

A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createEndpoint

default CompletableFuture<CreateEndpointResponse> createEndpoint(CreateEndpointRequest createEndpointRequest)

Creates an endpoint using the provided settings.

Parameters:

createEndpointRequest -

Returns:

A Java Future containing the result of the CreateEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createEventSubscription

default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest 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.

Parameters:

createEventSubscriptionRequest -

Returns:

A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createReplicationInstance

default CompletableFuture<CreateReplicationInstanceResponse> createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)

Creates the replication instance using the specified parameters.

Parameters:

createReplicationInstanceRequest -

Returns:

A Java Future containing the result of the CreateReplicationInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createReplicationSubnetGroup

default CompletableFuture<CreateReplicationSubnetGroupResponse> createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)

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

Parameters:

createReplicationSubnetGroupRequest -

Returns:

A Java Future containing the result of the CreateReplicationSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createReplicationTask

default CompletableFuture<CreateReplicationTaskResponse> createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)

Creates a replication task using the specified parameters.

Parameters:

createReplicationTaskRequest -

Returns:

A Java Future containing the result of the CreateReplicationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteCertificate

default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

Deletes the specified certificate.

Parameters:

deleteCertificateRequest -

Returns:

A Java Future containing the result of the DeleteCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteEndpoint

default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

Deletes the specified endpoint.

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

Parameters:

deleteEndpointRequest -

Returns:

A Java Future containing the result of the DeleteEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteEventSubscription

default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)

Deletes an AWS DMS event subscription.

Parameters:

deleteEventSubscriptionRequest -

Returns:

A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteReplicationInstance

default CompletableFuture<DeleteReplicationInstanceResponse> deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)

Deletes the specified replication instance.

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

Parameters:

deleteReplicationInstanceRequest -

Returns:

A Java Future containing the result of the DeleteReplicationInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteReplicationSubnetGroup

default CompletableFuture<DeleteReplicationSubnetGroupResponse> deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)

Deletes a subnet group.

Parameters:

deleteReplicationSubnetGroupRequest -

Returns:

A Java Future containing the result of the DeleteReplicationSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteReplicationTask

default CompletableFuture<DeleteReplicationTaskResponse> deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)

Deletes the specified replication task.

Parameters:

deleteReplicationTaskRequest -

Returns:

A Java Future containing the result of the DeleteReplicationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeAccountAttributes

default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest 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.

Parameters:

describeAccountAttributesRequest -

Returns:

A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeCertificates

default CompletableFuture<DescribeCertificatesResponse> describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)

Provides a description of the certificate.

Parameters:

describeCertificatesRequest -

Returns:

A Java Future containing the result of the DescribeCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeConnections

default CompletableFuture<DescribeConnectionsResponse> describeConnections(DescribeConnectionsRequest 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.

Parameters:

describeConnectionsRequest -

Returns:

A Java Future containing the result of the DescribeConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEndpointTypes

default CompletableFuture<DescribeEndpointTypesResponse> describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)

Returns information about the type of endpoints available.

Parameters:

describeEndpointTypesRequest -

Returns:

A Java Future containing the result of the DescribeEndpointTypes operation returned by the service.

See Also:

AWS API Documentation

describeEndpoints

default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)

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

Parameters:

describeEndpointsRequest -

Returns:

A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEventCategories

default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest 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.

Parameters:

describeEventCategoriesRequest -

Returns:

A Java Future containing the result of the DescribeEventCategories operation returned by the service.

See Also:

AWS API Documentation

describeEventSubscriptions

default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest 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.

Parameters:

describeEventSubscriptionsRequest -

Returns:

A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEvents

default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest 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 .

Parameters:

describeEventsRequest -

Returns:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeOrderableReplicationInstances

default CompletableFuture<DescribeOrderableReplicationInstancesResponse> describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)

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

Parameters:

describeOrderableReplicationInstancesRequest -

Returns:

A Java Future containing the result of the DescribeOrderableReplicationInstances operation returned by the service.

See Also:

AWS API Documentation

describeRefreshSchemasStatus

default CompletableFuture<DescribeRefreshSchemasStatusResponse> describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)

Returns the status of the RefreshSchemas operation.

Parameters:

describeRefreshSchemasStatusRequest -

Returns:

A Java Future containing the result of the DescribeRefreshSchemasStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeReplicationInstances

default CompletableFuture<DescribeReplicationInstancesResponse> describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)

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

Parameters:

describeReplicationInstancesRequest -

Returns:

A Java Future containing the result of the DescribeReplicationInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeReplicationSubnetGroups

default CompletableFuture<DescribeReplicationSubnetGroupsResponse> describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)

Returns information about the replication subnet groups.

Parameters:

describeReplicationSubnetGroupsRequest -

Returns:

A Java Future containing the result of the DescribeReplicationSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeReplicationTasks

default CompletableFuture<DescribeReplicationTasksResponse> describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)

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

Parameters:

describeReplicationTasksRequest -

Returns:

A Java Future containing the result of the DescribeReplicationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeSchemas

default CompletableFuture<DescribeSchemasResponse> describeSchemas(DescribeSchemasRequest describeSchemasRequest)

Returns information about the schema for the specified endpoint.

Parameters:

describeSchemasRequest -

Returns:

A Java Future containing the result of the DescribeSchemas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeTableStatistics

default CompletableFuture<DescribeTableStatisticsResponse> describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)

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

Parameters:

describeTableStatisticsRequest -

Returns:

A Java Future containing the result of the DescribeTableStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

importCertificate

default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest)

Uploads the specified certificate.

Parameters:

importCertificateRequest -

Returns:

A Java Future containing the result of the ImportCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags for an AWS DMS resource.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyEndpoint

default CompletableFuture<ModifyEndpointResponse> modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)

Modifies the specified endpoint.

Parameters:

modifyEndpointRequest -

Returns:

A Java Future containing the result of the ModifyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyEventSubscription

default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)

Modifies an existing AWS DMS event notification subscription.

Parameters:

modifyEventSubscriptionRequest -

Returns:

A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyReplicationInstance

default CompletableFuture<ModifyReplicationInstanceResponse> modifyReplicationInstance(ModifyReplicationInstanceRequest 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.

Parameters:

modifyReplicationInstanceRequest -

Returns:

A Java Future containing the result of the ModifyReplicationInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyReplicationSubnetGroup

default CompletableFuture<ModifyReplicationSubnetGroupResponse> modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)

Modifies the settings for the specified replication subnet group.

Parameters:

modifyReplicationSubnetGroupRequest -

Returns:

A Java Future containing the result of the ModifyReplicationSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyReplicationTask

default CompletableFuture<ModifyReplicationTaskResponse> modifyReplicationTask(ModifyReplicationTaskRequest 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

Parameters:

modifyReplicationTaskRequest -

Returns:

A Java Future containing the result of the ModifyReplicationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

refreshSchemas

default CompletableFuture<RefreshSchemasResponse> refreshSchemas(RefreshSchemasRequest 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.

Parameters:

refreshSchemasRequest -

Returns:

A Java Future containing the result of the RefreshSchemas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

reloadTables

default CompletableFuture<ReloadTablesResponse> reloadTables(ReloadTablesRequest reloadTablesRequest)

Reloads the target database table with the source data.

Parameters:

reloadTablesRequest -

Returns:

A Java Future containing the result of the ReloadTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeTagsFromResource

default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes metadata tags from a DMS resource.

Parameters:

removeTagsFromResourceRequest -

Returns:

A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

startReplicationTask

default CompletableFuture<StartReplicationTaskResponse> startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)

Starts the replication task.

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

Parameters:

startReplicationTaskRequest -

Returns:

A Java Future containing the result of the StartReplicationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopReplicationTask

default CompletableFuture<StopReplicationTaskResponse> stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)

Stops the replication task.

Parameters:

stopReplicationTaskRequest -

Returns:

A Java Future containing the result of the StopReplicationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

testConnection

default CompletableFuture<TestConnectionResponse> testConnection(TestConnectionRequest testConnectionRequest)

Tests the connection between the replication instance and the endpoint.

Parameters:

testConnectionRequest -

Returns:

A Java Future containing the result of the TestConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation