com.amazonaws.services.databasemigrationservice

Interface AWSDatabaseMigrationService

All Known Subinterfaces:

AWSDatabaseMigrationServiceAsync

All Known Implementing Classes:

AbstractAWSDatabaseMigrationService, AbstractAWSDatabaseMigrationServiceAsync, AWSDatabaseMigrationServiceAsyncClient, AWSDatabaseMigrationServiceClient

public interface AWSDatabaseMigrationService

Interface for accessing AWS Database Migration Service.

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, MariaDB, Amazon Aurora, and MySQL. 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.

Method Summary

Methods

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.
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.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes the specified endpoint.
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.
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.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags for an AWS DMS resource.
ModifyEndpointResult	modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest) Modifies the specified endpoint.
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.
RefreshSchemasResult	refreshSchemas(RefreshSchemasRequest refreshSchemasRequest) Populates the schema for the specified endpoint.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from a DMS resource.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String) , sets the regional endpoint for this client's service calls.
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.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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

void setRegion(Region region)

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.

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.

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.

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.

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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

describeTableStatistics

DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)

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

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.

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.

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.

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.

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:

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.

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.

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.

startReplicationTask

StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)

Starts the replication task.

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.

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.

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.

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.