@ThreadSafe 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, 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 |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWS Database Migration Service
exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AWSDatabaseMigrationServiceClient()
Constructs a new client to invoke service methods on AWS Database
Migration Service.
|
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWS Database
Migration Service using the specified AWS account credentials.
|
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Database
Migration Service using the specified AWS account credentials and client
configuration options.
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWS Database
Migration Service using the specified AWS account credentials provider.
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Database
Migration Service using the specified AWS account credentials provider
and client configuration options.
|
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on AWS Database
Migration Service using the specified AWS account credentials provider,
client configuration options, and request metric collector.
|
AWSDatabaseMigrationServiceClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Database
Migration Service.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
For internal use only
|
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)
For internal use only
|
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)
For internal use only
|
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected static final ClientConfigurationFactory configFactory
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AWSDatabaseMigrationServiceClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AWSDatabaseMigrationServiceClient(ClientConfiguration 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.).DefaultAWSCredentialsProviderChainpublic AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials)
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.public AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials, ClientConfiguration 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.).public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider 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.public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration 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.).public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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 AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
For internal use only
addTagsToResource in interface AWSDatabaseMigrationServiceaddTagsToResourceRequest - ResourceNotFoundExceptionpublic CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates an endpoint using the provided settings.
createEndpoint in interface AWSDatabaseMigrationServicecreateEndpointRequest - KMSKeyNotAccessibleExceptionResourceAlreadyExistsExceptionResourceQuotaExceededExceptionpublic CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)
Creates the replication instance using the specified parameters.
createReplicationInstance in interface AWSDatabaseMigrationServicecreateReplicationInstanceRequest - AccessDeniedExceptionResourceAlreadyExistsExceptionInsufficientResourceCapacityExceptionResourceQuotaExceededExceptionStorageQuotaExceededExceptionResourceNotFoundExceptionReplicationSubnetGroupDoesNotCoverEnoughAZsExceptionInvalidResourceStateExceptionInvalidSubnetExceptionKMSKeyNotAccessibleExceptionpublic CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationSubnetGroup in interface AWSDatabaseMigrationServicecreateReplicationSubnetGroupRequest - AccessDeniedExceptionResourceAlreadyExistsExceptionResourceNotFoundExceptionResourceQuotaExceededExceptionReplicationSubnetGroupDoesNotCoverEnoughAZsExceptionInvalidSubnetExceptionpublic CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)
Creates a replication task using the specified parameters.
createReplicationTask in interface AWSDatabaseMigrationServicecreateReplicationTaskRequest - InvalidResourceStateExceptionResourceAlreadyExistsExceptionResourceNotFoundExceptionKMSKeyNotAccessibleExceptionResourceQuotaExceededExceptionpublic DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the specified endpoint.
deleteEndpoint in interface AWSDatabaseMigrationServicedeleteEndpointRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionpublic DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)
Deletes the specified replication instance.
deleteReplicationInstance in interface AWSDatabaseMigrationServicedeleteReplicationInstanceRequest - InvalidResourceStateExceptionResourceNotFoundExceptionpublic DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)
Deletes a subnet group.
deleteReplicationSubnetGroup in interface AWSDatabaseMigrationServicedeleteReplicationSubnetGroupRequest - InvalidResourceStateExceptionResourceNotFoundExceptionpublic DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)
Deletes the specified replication task.
deleteReplicationTask in interface AWSDatabaseMigrationServicedeleteReplicationTaskRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionpublic 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.
describeAccountAttributes in interface AWSDatabaseMigrationServicedescribeAccountAttributesRequest - public 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.
describeConnections in interface AWSDatabaseMigrationServicedescribeConnectionsRequest - ResourceNotFoundExceptionpublic DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)
Returns information about the type of endpoints available.
describeEndpointTypes in interface AWSDatabaseMigrationServicedescribeEndpointTypesRequest - public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns information about the endpoints for your account in the current region.
describeEndpoints in interface AWSDatabaseMigrationServicedescribeEndpointsRequest - ResourceNotFoundExceptionpublic DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstances in interface AWSDatabaseMigrationServicedescribeOrderableReplicationInstancesRequest - public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatus in interface AWSDatabaseMigrationServicedescribeRefreshSchemasStatusRequest - InvalidResourceStateExceptionResourceNotFoundExceptionpublic DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)
Returns information about replication instances for your account in the current region.
describeReplicationInstances in interface AWSDatabaseMigrationServicedescribeReplicationInstancesRequest - ResourceNotFoundExceptionpublic DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)
Returns information about the replication subnet groups.
describeReplicationSubnetGroups in interface AWSDatabaseMigrationServicedescribeReplicationSubnetGroupsRequest - ResourceNotFoundExceptionpublic DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)
Returns information about replication tasks for your account in the current region.
describeReplicationTasks in interface AWSDatabaseMigrationServicedescribeReplicationTasksRequest - ResourceNotFoundExceptionpublic DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest)
Returns information about the schema for the specified endpoint.
describeSchemas in interface AWSDatabaseMigrationServicedescribeSchemasRequest - InvalidResourceStateExceptionResourceNotFoundExceptionpublic DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
describeTableStatistics in interface AWSDatabaseMigrationServicedescribeTableStatisticsRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
For internal use only
listTagsForResource in interface AWSDatabaseMigrationServicelistTagsForResourceRequest - ResourceNotFoundExceptionpublic ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)
Modifies the specified endpoint.
modifyEndpoint in interface AWSDatabaseMigrationServicemodifyEndpointRequest - InvalidResourceStateExceptionResourceNotFoundExceptionResourceAlreadyExistsExceptionKMSKeyNotAccessibleExceptionpublic 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.
modifyReplicationInstance in interface AWSDatabaseMigrationServicemodifyReplicationInstanceRequest - InvalidResourceStateExceptionResourceAlreadyExistsExceptionResourceNotFoundExceptionInsufficientResourceCapacityExceptionStorageQuotaExceededExceptionUpgradeDependencyFailureExceptionpublic ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroup in interface AWSDatabaseMigrationServicemodifyReplicationSubnetGroupRequest - ResourceNotFoundExceptionResourceQuotaExceededExceptionSubnetAlreadyInUseExceptionReplicationSubnetGroupDoesNotCoverEnoughAZsExceptionInvalidSubnetExceptionpublic 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.
refreshSchemas in interface AWSDatabaseMigrationServicerefreshSchemasRequest - InvalidResourceStateExceptionResourceNotFoundExceptionKMSKeyNotAccessibleExceptionResourceQuotaExceededExceptionpublic RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
For internal use only
removeTagsFromResource in interface AWSDatabaseMigrationServiceremoveTagsFromResourceRequest - ResourceNotFoundExceptionpublic StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)
Starts the replication task.
startReplicationTask in interface AWSDatabaseMigrationServicestartReplicationTaskRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionpublic StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)
Stops the replication task.
stopReplicationTask in interface AWSDatabaseMigrationServicestopReplicationTaskRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionpublic TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)
Tests the connection between the replication instance and the endpoint.
testConnection in interface AWSDatabaseMigrationServicetestConnectionRequest - ResourceNotFoundExceptionInvalidResourceStateExceptionKMSKeyNotAccessibleExceptionResourceQuotaExceededExceptionpublic 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 requestCopyright © 2016. All rights reserved.