public interface AWSDatabaseMigrationService
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDatabaseMigrationService
instead.
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, 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
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.
|
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.
|
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.
|
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.
|
static final String ENDPOINT_PREFIX
void setEndpoint(String endpoint)
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.
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.void setRegion(Region region)
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.
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
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.
addTagsToResourceRequest
- ResourceNotFoundException
- The resource could not be found.CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates an endpoint using the provided settings.
createEndpointRequest
- KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)
Creates the replication instance using the specified parameters.
createReplicationInstanceRequest
- AccessDeniedException
- AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.InsufficientResourceCapacityException
- There are not enough resources allocated to the database migration.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.StorageQuotaExceededException
- The storage quota has been exceeded.ResourceNotFoundException
- The resource could not be found.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.InvalidSubnetException
- The subnet provided is invalid.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationSubnetGroupRequest
- AccessDeniedException
- AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidSubnetException
- The subnet provided is invalid.CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)
Creates a replication task using the specified parameters.
createReplicationTaskRequest
- 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.DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
deleteCertificateRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpointRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.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.
deleteReplicationInstanceRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)
Deletes a subnet group.
deleteReplicationSubnetGroupRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)
Deletes the specified replication task.
deleteReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.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.
describeAccountAttributesRequest
- DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Provides a description of the certificate.
describeCertificatesRequest
- ResourceNotFoundException
- The resource could not be found.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.
describeConnectionsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)
Returns information about the type of endpoints available.
describeEndpointTypesRequest
- DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns information about the endpoints for your account in the current region.
describeEndpointsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstancesRequest
- DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatusRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)
Returns information about replication instances for your account in the current region.
describeReplicationInstancesRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)
Returns information about the replication subnet groups.
describeReplicationSubnetGroupsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)
Returns information about replication tasks for your account in the current region.
describeReplicationTasksRequest
- ResourceNotFoundException
- The resource could not be found.DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest)
Returns information about the schema for the specified endpoint.
describeSchemasRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
describeTableStatisticsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest)
Uploads the specified certificate.
importCertificateRequest
- ResourceAlreadyExistsException
- The resource you are attempting to create already exists.InvalidCertificateException
- The certificate was not valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags for an AWS DMS resource.
listTagsForResourceRequest
- ResourceNotFoundException
- The resource could not be found.ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)
Modifies the specified endpoint.
modifyEndpointRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.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.
modifyReplicationInstanceRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.InsufficientResourceCapacityException
- There are not enough resources allocated to the database migration.StorageQuotaExceededException
- The storage quota has been exceeded.UpgradeDependencyFailureException
- An upgrade dependency is preventing the database migration.ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroupRequest
- AccessDeniedException
- AWS DMS was denied access to the endpoint.ResourceNotFoundException
- The resource could not be found.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.SubnetAlreadyInUseException
- The specified subnet is already in use.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet
group and add more AZs.InvalidSubnetException
- The subnet provided is invalid.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.
refreshSchemasRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from a DMS resource.
removeTagsFromResourceRequest
- ResourceNotFoundException
- The resource could not be found.StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)
Starts the replication task.
startReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)
Stops the replication task.
stopReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)
Tests the connection between the replication instance and the endpoint.
testConnectionRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.