com.amazonaws.services.databasemigrationservice

Interface AWSDatabaseMigrationService

All Known Subinterfaces:

AWSDatabaseMigrationServiceAsync

All Known Implementing Classes:

AbstractAWSDatabaseMigrationService, AbstractAWSDatabaseMigrationServiceAsync, AWSDatabaseMigrationServiceAsyncClient, AWSDatabaseMigrationServiceClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDatabaseMigrationService

Interface for accessing AWS Database Migration Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSDatabaseMigrationService instead.

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?

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.
CreateEndpointResult	createEndpoint(CreateEndpointRequest createEndpointRequest) Creates an endpoint using the provided settings.
CreateEventSubscriptionResult	createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an AWS DMS event notification subscription.
CreateReplicationInstanceResult	createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest) Creates the replication instance using the specified parameters.
CreateReplicationSubnetGroupResult	createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest) Creates a replication subnet group given a list of the subnet IDs in a VPC.
CreateReplicationTaskResult	createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest) Creates a replication task using the specified parameters.
DeleteCertificateResult	deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) Deletes the specified certificate.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes the specified endpoint.
DeleteEventSubscriptionResult	deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an AWS DMS event subscription.
DeleteReplicationInstanceResult	deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest) Deletes the specified replication instance.
DeleteReplicationSubnetGroupResult	deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest) Deletes a subnet group.
DeleteReplicationTaskResult	deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest) Deletes the specified replication task.
DescribeAccountAttributesResult	describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the AWS DMS attributes for a customer account.
DescribeCertificatesResult	describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) Provides a description of the certificate.
DescribeConnectionsResult	describeConnections(DescribeConnectionsRequest describeConnectionsRequest) Describes the status of the connections that have been made between the replication instance and an endpoint.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) Returns information about the endpoints for your account in the current region.
DescribeEndpointTypesResult	describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest) Returns information about the type of endpoints available.
DescribeEventCategoriesResult	describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Lists categories for all event source types, or, if specified, for a specified source type.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Lists events for a given source identifier and source type.
DescribeEventSubscriptionsResult	describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the event subscriptions for a customer account.
DescribeOrderableReplicationInstancesResult	describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest) Returns information about the replication instance types that can be created in the specified region.
DescribeRefreshSchemasStatusResult	describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest) Returns the status of the RefreshSchemas operation.
DescribeReplicationInstancesResult	describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest) Returns information about replication instances for your account in the current region.
DescribeReplicationSubnetGroupsResult	describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest) Returns information about the replication subnet groups.
DescribeReplicationTasksResult	describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest) Returns information about replication tasks for your account in the current region.
DescribeSchemasResult	describeSchemas(DescribeSchemasRequest describeSchemasRequest) Returns information about the schema for the specified endpoint.
DescribeTableStatisticsResult	describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest) Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ImportCertificateResult	importCertificate(ImportCertificateRequest importCertificateRequest) Uploads the specified certificate.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags for an AWS DMS resource.
ModifyEndpointResult	modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest) Modifies the specified endpoint.
ModifyEventSubscriptionResult	modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing AWS DMS event notification subscription.
ModifyReplicationInstanceResult	modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest) Modifies the replication instance to apply new settings.
ModifyReplicationSubnetGroupResult	modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest) Modifies the settings for the specified replication subnet group.
ModifyReplicationTaskResult	modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest) Modifies the specified replication task.
RefreshSchemasResult	refreshSchemas(RefreshSchemasRequest refreshSchemasRequest) Populates the schema for the specified endpoint.
ReloadTablesResult	reloadTables(ReloadTablesRequest reloadTablesRequest) Reloads the target database table with the source data.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from a DMS resource.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartReplicationTaskResult	startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest) Starts the replication task.
StopReplicationTaskResult	stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest) Stops the replication task.
TestConnectionResult	testConnection(TestConnectionRequest testConnectionRequest) Tests the connection between the replication instance and the endpoint.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "dms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "dms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

addTagsToResource

AddTagsToResourceResult 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:

Result of the AddTagsToResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

createEndpoint

CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)

Creates an endpoint using the provided settings.

Parameters:

createEndpointRequest -

Returns:

Result of the CreateEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createEventSubscription

CreateEventSubscriptionResult 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:

Result of the CreateEventSubscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createReplicationInstance

CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)

Creates the replication instance using the specified parameters.

Parameters:

createReplicationInstanceRequest -

Returns:

Result of the CreateReplicationInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createReplicationSubnetGroup

CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)

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

Parameters:

createReplicationSubnetGroupRequest -

Returns:

Result of the CreateReplicationSubnetGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createReplicationTask

CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)

Creates a replication task using the specified parameters.

Parameters:

createReplicationTaskRequest -

Returns:

Result of the CreateReplicationTask operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteCertificate

DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

Deletes the specified certificate.

Parameters:

deleteCertificateRequest -

Returns:

Result of the DeleteCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

deleteEndpoint

DeleteEndpointResult 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:

Result of the DeleteEndpoint operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

deleteEventSubscription

DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)

Deletes an AWS DMS event subscription.

Parameters:

deleteEventSubscriptionRequest -

Returns:

Result of the DeleteEventSubscription operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

deleteReplicationInstance

DeleteReplicationInstanceResult 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:

Result of the DeleteReplicationInstance operation returned by the service.

Throws:

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

deleteReplicationSubnetGroup

DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)

Deletes a subnet group.

Parameters:

deleteReplicationSubnetGroupRequest -

Returns:

Result of the DeleteReplicationSubnetGroup operation returned by the service.

Throws:

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

deleteReplicationTask

DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)

Deletes the specified replication task.

Parameters:

deleteReplicationTaskRequest -

Returns:

Result of the DeleteReplicationTask operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

describeAccountAttributes

DescribeAccountAttributesResult 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:

Result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeCertificates

DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)

Provides a description of the certificate.

Parameters:

describeCertificatesRequest -

Returns:

Result of the DescribeCertificates operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeConnections

DescribeConnectionsResult 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:

Result of the DescribeConnections operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEndpointTypes

DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)

Returns information about the type of endpoints available.

Parameters:

describeEndpointTypesRequest -

Returns:

Result of the DescribeEndpointTypes operation returned by the service.

See Also:

AWS API Documentation

describeEndpoints

DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)

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

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEventCategories

DescribeEventCategoriesResult 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:

Result of the DescribeEventCategories operation returned by the service.

See Also:

AWS API Documentation

describeEventSubscriptions

DescribeEventSubscriptionsResult 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:

Result of the DescribeEventSubscriptions operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEvents

DescribeEventsResult 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:

Result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeOrderableReplicationInstances

DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)

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

Parameters:

describeOrderableReplicationInstancesRequest -

Returns:

Result of the DescribeOrderableReplicationInstances operation returned by the service.

See Also:

AWS API Documentation

describeRefreshSchemasStatus

DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)

Returns the status of the RefreshSchemas operation.

Parameters:

describeRefreshSchemasStatusRequest -

Returns:

Result of the DescribeRefreshSchemasStatus operation returned by the service.

Throws:

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeReplicationInstances

DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)

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

Parameters:

describeReplicationInstancesRequest -

Returns:

Result of the DescribeReplicationInstances operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeReplicationSubnetGroups

DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)

Returns information about the replication subnet groups.

Parameters:

describeReplicationSubnetGroupsRequest -

Returns:

Result of the DescribeReplicationSubnetGroups operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeReplicationTasks

DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)

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

Parameters:

describeReplicationTasksRequest -

Returns:

Result of the DescribeReplicationTasks operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeSchemas

DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest)

Returns information about the schema for the specified endpoint.

Parameters:

describeSchemasRequest -

Returns:

Result of the DescribeSchemas operation returned by the service.

Throws:

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeTableStatistics

DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)

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

Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

Parameters:

describeTableStatisticsRequest -

Returns:

Result of the DescribeTableStatistics operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

importCertificate

ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest)

Uploads the specified certificate.

Parameters:

importCertificateRequest -

Returns:

Result of the ImportCertificate operation returned by the service.

Throws:

ResourceAlreadyExistsException - The resource you are attempting to create already exists.

InvalidCertificateException - The certificate was not valid.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags for an AWS DMS resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

modifyEndpoint

ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)

Modifies the specified endpoint.

Parameters:

modifyEndpointRequest -

Returns:

Result of the ModifyEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyEventSubscription

ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)

Modifies an existing AWS DMS event notification subscription.

Parameters:

modifyEventSubscriptionRequest -

Returns:

Result of the ModifyEventSubscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyReplicationInstance

ModifyReplicationInstanceResult 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:

Result of the ModifyReplicationInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyReplicationSubnetGroup

ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)

Modifies the settings for the specified replication subnet group.

Parameters:

modifyReplicationSubnetGroupRequest -

Returns:

Result of the ModifyReplicationSubnetGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyReplicationTask

ModifyReplicationTaskResult 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:

Result of the ModifyReplicationTask operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

refreshSchemas

RefreshSchemasResult 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:

Result of the RefreshSchemas operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

reloadTables

ReloadTablesResult reloadTables(ReloadTablesRequest reloadTablesRequest)

Reloads the target database table with the source data.

Parameters:

reloadTablesRequest -

Returns:

Result of the ReloadTables operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

removeTagsFromResource

RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes metadata tags from a DMS resource.

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

startReplicationTask

StartReplicationTaskResult 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:

Result of the StartReplicationTask operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

stopReplicationTask

StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)

Stops the replication task.

Parameters:

stopReplicationTaskRequest -

Returns:

Result of the StopReplicationTask operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.

See Also:

AWS API Documentation

testConnection

TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)

Tests the connection between the replication instance and the endpoint.

Parameters:

testConnectionRequest -

Returns:

Result of the TestConnection operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.