@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDatabaseMigrationServiceClient extends AmazonWebServiceClient implements AWSDatabaseMigrationService
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 What Is AWS Database Migration Service? in the AWS Database Migration User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSDatabaseMigrationServiceClient()
Deprecated.
|
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSDatabaseMigrationServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSDatabaseMigrationServiceClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSDatabaseMigrationServiceClient()
AWSDatabaseMigrationServiceClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSDatabaseMigrationServiceClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Database Migration Service
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSDatabaseMigrationServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Database Migration Service
(ex: proxy settings, retry counts, etc.).@Deprecated public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Database Migration Service
(ex: proxy settings, retry counts, etc.).@Deprecated public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Database Migration Service
(ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSDatabaseMigrationServiceClientBuilder builder()
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to an AWS 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.
addTagsToResource in interface AWSDatabaseMigrationServiceaddTagsToResourceRequest - Associates a set of tags with an AWS DMS resource.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
AddTagsToResourceRequest request = new AddTagsToResourceRequest()
//Required. Use the ARN of the resource you want to tag.
.withResourceArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E")//Required. Use the Key/Value pair format.
.withTags(new Tag().withKey("Acount").withValue("1633456"));
AddTagsToResourceResult response = client.addTagsToResource(request);public ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a replication instance).
applyPendingMaintenanceAction in interface AWSDatabaseMigrationServiceapplyPendingMaintenanceActionRequest - ResourceNotFoundException - The resource could not be found.public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
Creates an endpoint using the provided settings.
createEndpoint in interface AWSDatabaseMigrationServicecreateEndpointRequest - KMSKeyNotAccessibleException - AWS DMS cannot access the AWS 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. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateEndpointRequest request = new CreateEndpointRequest().withEndpointIdentifier("test-endpoint-1").withEndpointType("source")
.withEngineName("mysql").withUsername("username").withPassword("pasword").withServerName("mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com")
.withPort(3306).withDatabaseName("testdb").withExtraConnectionAttributes("")
.withKmsKeyId("arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd")
.withTags(new Tag().withKey("Acount").withValue("143327655")).withCertificateArn("").withSslMode("require");
CreateEndpointResult response = client.createEndpoint(request);public CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest request)
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.
createEventSubscription in interface AWSDatabaseMigrationServicecreateEventSubscriptionRequest - ResourceQuotaExceededException - The quota for this resource quota has been exceeded.ResourceNotFoundException - The resource could not be found.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.KMSAccessDeniedException - The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.KMSDisabledException - The specified master key (CMK) isn't enabled.KMSInvalidStateException - The state of the specified AWS KMS resource isn't valid for this request.KMSNotFoundException - The specified AWS KMS entity or resource can't be found.KMSThrottlingException - This request triggered AWS KMS request throttling.public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)
Creates the replication instance using the specified parameters.
AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For information on the required permissions, see IAM Permissions Needed to Use AWS DMS.
createReplicationInstance in interface AWSDatabaseMigrationServicecreateReplicationInstanceRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.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 AWS KMS key.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationInstanceRequest request = new CreateReplicationInstanceRequest().withReplicationInstanceIdentifier("").withAllocatedStorage(123)
.withReplicationInstanceClass("").withVpcSecurityGroupIds(new ArrayList()).withAvailabilityZone("").withReplicationSubnetGroupIdentifier("")
.withPreferredMaintenanceWindow("").withMultiAZ(true).withEngineVersion("").withAutoMinorVersionUpgrade(true)
.withTags(new Tag().withKey("string").withValue("string")).withKmsKeyId("").withPubliclyAccessible(true);
CreateReplicationInstanceResult response = client.createReplicationInstance(request);public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationSubnetGroup in interface AWSDatabaseMigrationServicecreateReplicationSubnetGroupRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.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.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationSubnetGroupRequest request = new CreateReplicationSubnetGroupRequest()
.withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366").withReplicationSubnetGroupDescription("US West subnet group")
.withSubnetIds("subnet-e145356n", "subnet-58f79200").withTags(new Tag().withKey("Acount").withValue("145235"));
CreateReplicationSubnetGroupResult response = client.createReplicationSubnetGroup(request);public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)
Creates a replication task using the specified parameters.
createReplicationTask in interface AWSDatabaseMigrationServicecreateReplicationTaskRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.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 AWS KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationTaskRequest request = new CreateReplicationTaskRequest().withReplicationTaskIdentifier("task1")
.withSourceEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE")
.withTargetEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E")
.withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withMigrationType("full-load")
.withTableMappings("file://mappingfile.json").withReplicationTaskSettings("").withCdcStartTime(new Date("2016-12-14T18:25:43Z"))
.withTags(new Tag().withKey("Acount").withValue("24352226"));
CreateReplicationTaskResult response = client.createReplicationTask(request);public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
Deletes the specified certificate.
deleteCertificate in interface AWSDatabaseMigrationServicedeleteCertificateRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteCertificateRequest request = new DeleteCertificateRequest().withCertificateArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ");
DeleteCertificateResult response = client.deleteCertificate(request);public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
Deletes the connection between a replication instance and an endpoint.
deleteConnection in interface AWSDatabaseMigrationServicedeleteConnectionRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpoint in interface AWSDatabaseMigrationServicedeleteEndpointRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteEndpointRequest request = new DeleteEndpointRequest().withEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM");
DeleteEndpointResult response = client.deleteEndpoint(request);public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an AWS DMS event subscription.
deleteEventSubscription in interface AWSDatabaseMigrationServicedeleteEventSubscriptionRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.public DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest request)
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
deleteReplicationInstance in interface AWSDatabaseMigrationServicedeleteReplicationInstanceRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationInstanceRequest request = new DeleteReplicationInstanceRequest()
.withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ");
DeleteReplicationInstanceResult response = client.deleteReplicationInstance(request);public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
Deletes a subnet group.
deleteReplicationSubnetGroup in interface AWSDatabaseMigrationServicedeleteReplicationSubnetGroupRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationSubnetGroupRequest request = new DeleteReplicationSubnetGroupRequest()
.withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366");
DeleteReplicationSubnetGroupResult response = client.deleteReplicationSubnetGroup(request);public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)
Deletes the specified replication task.
deleteReplicationTask in interface AWSDatabaseMigrationServicedeleteReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationTaskRequest request = new DeleteReplicationTaskRequest()
.withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ");
DeleteReplicationTaskResult response = client.deleteReplicationTask(request);public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
describeAccountAttributes in interface AWSDatabaseMigrationServicedescribeAccountAttributesRequest - AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest(); DescribeAccountAttributesResult response = client.describeAccountAttributes(request);
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
Provides a description of the certificate.
describeCertificates in interface AWSDatabaseMigrationServicedescribeCertificatesRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeCertificatesRequest request = new DescribeCertificatesRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
.withMaxRecords(123).withMarker("");
DescribeCertificatesResult response = client.describeCertificates(request);public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
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.
describeConnections in interface AWSDatabaseMigrationServicedescribeConnectionsRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeConnectionsRequest request = new DescribeConnectionsRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
.withMaxRecords(123).withMarker("");
DescribeConnectionsResult response = client.describeConnections(request);public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)
Returns information about the type of endpoints available.
describeEndpointTypes in interface AWSDatabaseMigrationServicedescribeEndpointTypesRequest - AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeEndpointTypesRequest request = new DescribeEndpointTypesRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
.withMaxRecords(123).withMarker("");
DescribeEndpointTypesResult response = client.describeEndpointTypes(request);public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
Returns information about the endpoints for your account in the current region.
describeEndpoints in interface AWSDatabaseMigrationServicedescribeEndpointsRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeEndpointsRequest request = new DescribeEndpointsRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
.withMaxRecords(123).withMarker("");
DescribeEndpointsResult response = client.describeEndpoints(request);public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
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.
describeEventCategories in interface AWSDatabaseMigrationServicedescribeEventCategoriesRequest - public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
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.
describeEventSubscriptions in interface AWSDatabaseMigrationServicedescribeEventSubscriptionsRequest - ResourceNotFoundException - The resource could not be found.public DescribeEventsResult describeEvents(DescribeEventsRequest request)
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 in the AWS Database Migration User Guide.
describeEvents in interface AWSDatabaseMigrationServicedescribeEventsRequest - public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstances in interface AWSDatabaseMigrationServicedescribeOrderableReplicationInstancesRequest - AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeOrderableReplicationInstancesRequest request = new DescribeOrderableReplicationInstancesRequest().withMaxRecords(123).withMarker("");
DescribeOrderableReplicationInstancesResult response = client.describeOrderableReplicationInstances(request);public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
For internal use only
describePendingMaintenanceActions in interface AWSDatabaseMigrationServicedescribePendingMaintenanceActionsRequest - ResourceNotFoundException - The resource could not be found.public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatus in interface AWSDatabaseMigrationServicedescribeRefreshSchemasStatusRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeRefreshSchemasStatusRequest request = new DescribeRefreshSchemasStatusRequest().withEndpointArn("");
DescribeRefreshSchemasStatusResult response = client.describeRefreshSchemasStatus(request);public DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)
Returns information about the task logs for the specified task.
describeReplicationInstanceTaskLogs in interface AWSDatabaseMigrationServicedescribeReplicationInstanceTaskLogsRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)
Returns information about replication instances for your account in the current region.
describeReplicationInstances in interface AWSDatabaseMigrationServicedescribeReplicationInstancesRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationInstancesRequest request = new DescribeReplicationInstancesRequest()
.withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationInstancesResult response = client.describeReplicationInstances(request);public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
Returns information about the replication subnet groups.
describeReplicationSubnetGroups in interface AWSDatabaseMigrationServicedescribeReplicationSubnetGroupsRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationSubnetGroupsRequest request = new DescribeReplicationSubnetGroupsRequest()
.withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationSubnetGroupsResult response = client.describeReplicationSubnetGroups(request);public DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)
Returns the task assessment results from Amazon S3. This action always returns the latest results.
describeReplicationTaskAssessmentResults in interface AWSDatabaseMigrationServicedescribeReplicationTaskAssessmentResultsRequest - ResourceNotFoundException - The resource could not be found.public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)
Returns information about replication tasks for your account in the current region.
describeReplicationTasks in interface AWSDatabaseMigrationServicedescribeReplicationTasksRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationTasksRequest request = new DescribeReplicationTasksRequest()
.withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationTasksResult response = client.describeReplicationTasks(request);public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)
Returns information about the schema for the specified endpoint.
describeSchemas in interface AWSDatabaseMigrationServicedescribeSchemasRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeSchemasRequest request = new DescribeSchemasRequest().withEndpointArn("").withMaxRecords(123).withMarker("");
DescribeSchemasResult response = client.describeSchemas(request);public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest request)
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.
describeTableStatistics in interface AWSDatabaseMigrationServicedescribeTableStatisticsRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeTableStatisticsRequest request = new DescribeTableStatisticsRequest().withReplicationTaskArn("").withMaxRecords(123).withMarker("");
DescribeTableStatisticsResult response = client.describeTableStatistics(request);public ImportCertificateResult importCertificate(ImportCertificateRequest request)
Uploads the specified certificate.
importCertificate in interface AWSDatabaseMigrationServiceimportCertificateRequest - ResourceAlreadyExistsException - The resource you are attempting to create already exists.InvalidCertificateException - The certificate was not valid.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ImportCertificateRequest request = new ImportCertificateRequest().withCertificateIdentifier("").withCertificatePem("");
ImportCertificateResult response = client.importCertificate(request);public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags for an AWS DMS resource.
listTagsForResource in interface AWSDatabaseMigrationServicelistTagsForResourceRequest - ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ListTagsForResourceRequest request = new ListTagsForResourceRequest().withResourceArn("");
ListTagsForResourceResult response = client.listTagsForResource(request);public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)
Modifies the specified endpoint.
modifyEndpoint in interface AWSDatabaseMigrationServicemodifyEndpointRequest - 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 AWS KMS key.AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyEndpointRequest request = new ModifyEndpointRequest().withEndpointArn("").withEndpointIdentifier("").withEndpointType("source")
.withEngineName("").withUsername("").withPassword("").withServerName("").withPort(123).withDatabaseName("").withExtraConnectionAttributes("")
.withCertificateArn("").withSslMode("require");
ModifyEndpointResult response = client.modifyEndpoint(request);public ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing AWS DMS event notification subscription.
modifyEventSubscription in interface AWSDatabaseMigrationServicemodifyEventSubscriptionRequest - 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.KMSAccessDeniedException - The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.KMSDisabledException - The specified master key (CMK) isn't enabled.KMSInvalidStateException - The state of the specified AWS KMS resource isn't valid for this request.KMSNotFoundException - The specified AWS KMS entity or resource can't be found.KMSThrottlingException - This request triggered AWS KMS request throttling.public ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest request)
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.
modifyReplicationInstance in interface AWSDatabaseMigrationServicemodifyReplicationInstanceRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.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.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyReplicationInstanceRequest request = new ModifyReplicationInstanceRequest()
.withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withAllocatedStorage(123)
.withApplyImmediately(true).withReplicationInstanceClass("dms.t2.micro").withVpcSecurityGroupIds(new ArrayList())
.withPreferredMaintenanceWindow("sun:06:00-sun:14:00").withMultiAZ(true).withEngineVersion("1.5.0").withAllowMajorVersionUpgrade(true)
.withAutoMinorVersionUpgrade(true).withReplicationInstanceIdentifier("test-rep-1");
ModifyReplicationInstanceResult response = client.modifyReplicationInstance(request);public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroup in interface AWSDatabaseMigrationServicemodifyReplicationSubnetGroupRequest - AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.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.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyReplicationSubnetGroupRequest request = new ModifyReplicationSubnetGroupRequest().withReplicationSubnetGroupIdentifier("")
.withReplicationSubnetGroupDescription("").withSubnetIds(new ArrayList());
ModifyReplicationSubnetGroupResult response = client.modifyReplicationSubnetGroup(request);public ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest request)
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 Working with Migration Tasks in the AWS Database Migration Service User Guide.
modifyReplicationTask in interface AWSDatabaseMigrationServicemodifyReplicationTaskRequest - 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 AWS KMS key.public RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest request)
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
rebootReplicationInstance in interface AWSDatabaseMigrationServicerebootReplicationInstanceRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.public RefreshSchemasResult refreshSchemas(RefreshSchemasRequest request)
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.
refreshSchemas in interface AWSDatabaseMigrationServicerefreshSchemasRequest - 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 AWS KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
RefreshSchemasRequest request = new RefreshSchemasRequest().withEndpointArn("").withReplicationInstanceArn("");
RefreshSchemasResult response = client.refreshSchemas(request);public ReloadTablesResult reloadTables(ReloadTablesRequest request)
Reloads the target database table with the source data.
reloadTables in interface AWSDatabaseMigrationServicereloadTablesRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from a DMS resource.
removeTagsFromResource in interface AWSDatabaseMigrationServiceremoveTagsFromResourceRequest - Removes one or more tags from an AWS DMS resource.ResourceNotFoundException - The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceArn(
"arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E").withTagKeys(new ArrayList());
RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)
Starts the replication task.
For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
startReplicationTask in interface AWSDatabaseMigrationServicestartReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AccessDeniedException - AWS DMS was denied access to the endpoint. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
StartReplicationTaskRequest request = new StartReplicationTaskRequest()
.withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withStartReplicationTaskType("start-replication")
.withCdcStartTime(new Date("2016-12-14T13:33:20Z"));
StartReplicationTaskResult response = client.startReplicationTask(request);public StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)
Starts the replication task assessment for unsupported data types in the source database.
startReplicationTaskAssessment in interface AWSDatabaseMigrationServicestartReplicationTaskAssessmentRequest - InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException - The resource could not be found.public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)
Stops the replication task.
stopReplicationTask in interface AWSDatabaseMigrationServicestopReplicationTaskRequest - ResourceNotFoundException - The resource could not be found.InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
StopReplicationTaskRequest request = new StopReplicationTaskRequest()
.withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E");
StopReplicationTaskResult response = client.stopReplicationTask(request);public TestConnectionResult testConnection(TestConnectionRequest request)
Tests the connection between the replication instance and the endpoint.
testConnection in interface AWSDatabaseMigrationServicetestConnectionRequest - 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 AWS KMS key.ResourceQuotaExceededException - The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
TestConnectionRequest request = new TestConnectionRequest().withReplicationInstanceArn(
"arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withEndpointArn(
"arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM");
TestConnectionResult response = client.testConnection(request);public 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 the request.
getCachedResponseMetadata in interface AWSDatabaseMigrationServicerequest - The originally executed requestpublic AWSDatabaseMigrationServiceWaiters waiters()
waiters in interface AWSDatabaseMigrationServicepublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSDatabaseMigrationServiceshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.