Class AWSDatabaseMigrationServiceClient
- All Implemented Interfaces:
AWSDatabaseMigrationService
- Direct Known Subclasses:
AWSDatabaseMigrationServiceAsyncClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
(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
(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
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Database Migration Service. -
Method Summary
Modifier and TypeMethodDescriptionaddTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.createEndpoint
(CreateEndpointRequest createEndpointRequest) Creates an endpoint using the provided settings.createReplicationInstance
(CreateReplicationInstanceRequest createReplicationInstanceRequest) Creates the replication instance using the specified parameters.createReplicationSubnetGroup
(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest) Creates a replication subnet group given a list of the subnet IDs in a VPC.createReplicationTask
(CreateReplicationTaskRequest createReplicationTaskRequest) Creates a replication task using the specified parameters.deleteEndpoint
(DeleteEndpointRequest deleteEndpointRequest) Deletes the specified endpoint.deleteReplicationInstance
(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest) Deletes the specified replication instance.deleteReplicationSubnetGroup
(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest) Deletes a subnet group.deleteReplicationTask
(DeleteReplicationTaskRequest deleteReplicationTaskRequest) Deletes the specified replication task.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the AWS DMS attributes for a customer account.describeConnections
(DescribeConnectionsRequest describeConnectionsRequest) Describes the status of the connections that have been made between the replication instance and an endpoint.describeEndpoints
(DescribeEndpointsRequest describeEndpointsRequest) Returns information about the endpoints for your account in the current region.describeEndpointTypes
(DescribeEndpointTypesRequest describeEndpointTypesRequest) Returns information about the type of endpoints available.describeOrderableReplicationInstances
(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest) Returns information about the replication instance types that can be created in the specified region.describeRefreshSchemasStatus
(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest) Returns the status of the RefreshSchemas operation.describeReplicationInstances
(DescribeReplicationInstancesRequest describeReplicationInstancesRequest) Returns information about replication instances for your account in the current region.describeReplicationSubnetGroups
(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest) Returns information about the replication subnet groups.describeReplicationTasks
(DescribeReplicationTasksRequest describeReplicationTasksRequest) Returns information about replication tasks for your account in the current region.describeSchemas
(DescribeSchemasRequest describeSchemasRequest) Returns information about the schema for the specified endpoint.describeTableStatistics
(DescribeTableStatisticsRequest describeTableStatisticsRequest) Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags for an AWS DMS resource.modifyEndpoint
(ModifyEndpointRequest modifyEndpointRequest) Modifies the specified endpoint.modifyReplicationInstance
(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest) Modifies the replication instance to apply new settings.modifyReplicationSubnetGroup
(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest) Modifies the settings for the specified replication subnet group.refreshSchemas
(RefreshSchemasRequest refreshSchemasRequest) Populates the schema for the specified endpoint.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from a DMS resource.startReplicationTask
(StartReplicationTaskRequest startReplicationTaskRequest) Starts the replication task.stopReplicationTask
(StopReplicationTaskRequest stopReplicationTaskRequest) Stops the replication task.testConnection
(TestConnectionRequest testConnectionRequest) Tests the connection between the replication instance and the endpoint.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.databasemigrationservice.AWSDatabaseMigrationService
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Details
-
AWSDatabaseMigrationServiceClient
public AWSDatabaseMigrationServiceClient()Constructs a new client to invoke service methods on AWS Database Migration Service. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AWSDatabaseMigrationServiceClient
Constructs a new client to invoke service methods on AWS Database Migration Service. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to AWS Database Migration Service (ex: proxy settings, retry counts, etc.).- See Also:
-
AWSDatabaseMigrationServiceClient
Constructs a new client to invoke service methods on AWS Database Migration Service using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSDatabaseMigrationServiceClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AWSDatabaseMigrationServiceClient
Constructs a new client to invoke service methods on AWS Database Migration Service using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSDatabaseMigrationServiceClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AWSDatabaseMigrationServiceClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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 collector
-
-
Method Details
-
addTagsToResource
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.
- Specified by:
addTagsToResource
in interfaceAWSDatabaseMigrationService
- Parameters:
addTagsToResourceRequest
-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
createEndpoint
Creates an endpoint using the provided settings.
- Specified by:
createEndpoint
in interfaceAWSDatabaseMigrationService
- Parameters:
createEndpointRequest
-- Returns:
- Result of the CreateEndpoint operation returned by the service.
- Throws:
KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.
-
createReplicationInstance
public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest) Creates the replication instance using the specified parameters.
- Specified by:
createReplicationInstance
in interfaceAWSDatabaseMigrationService
- Parameters:
createReplicationInstanceRequest
-- Returns:
- Result of the CreateReplicationInstance operation returned by the service.
- Throws:
AccessDeniedException
- AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.InsufficientResourceCapacityException
- There are not enough resources allocated to the database migration.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.StorageQuotaExceededException
- The storage quota has been exceeded.ResourceNotFoundException
- The resource could not be found.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.InvalidSubnetException
- The subnet provided is invalid.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.
-
createReplicationSubnetGroup
public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest) Creates a replication subnet group given a list of the subnet IDs in a VPC.
- Specified by:
createReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Parameters:
createReplicationSubnetGroupRequest
-- Returns:
- Result of the CreateReplicationSubnetGroup operation returned by the service.
- Throws:
AccessDeniedException
- AWS DMS was denied access to the endpoint.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.InvalidSubnetException
- The subnet provided is invalid.
-
createReplicationTask
public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest) Creates a replication task using the specified parameters.
- Specified by:
createReplicationTask
in interfaceAWSDatabaseMigrationService
- Parameters:
createReplicationTaskRequest
-- Returns:
- Result of the CreateReplicationTask operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.
-
deleteEndpoint
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint. - Specified by:
deleteEndpoint
in interfaceAWSDatabaseMigrationService
- Parameters:
deleteEndpointRequest
-- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.
-
deleteReplicationInstance
public 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. - Specified by:
deleteReplicationInstance
in interfaceAWSDatabaseMigrationService
- Parameters:
deleteReplicationInstanceRequest
-- Returns:
- Result of the DeleteReplicationInstance operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.
-
deleteReplicationSubnetGroup
public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest) Deletes a subnet group.
- Specified by:
deleteReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Parameters:
deleteReplicationSubnetGroupRequest
-- Returns:
- Result of the DeleteReplicationSubnetGroup operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.
-
deleteReplicationTask
public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest) Deletes the specified replication task.
- Specified by:
deleteReplicationTask
in interfaceAWSDatabaseMigrationService
- Parameters:
deleteReplicationTaskRequest
-- Returns:
- Result of the DeleteReplicationTask operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.
-
describeAccountAttributes
public 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.
- Specified by:
describeAccountAttributes
in interfaceAWSDatabaseMigrationService
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
describeConnections
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.
- Specified by:
describeConnections
in interfaceAWSDatabaseMigrationService
- Parameters:
describeConnectionsRequest
-- Returns:
- Result of the DescribeConnections operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
describeEndpointTypes
public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest) Returns information about the type of endpoints available.
- Specified by:
describeEndpointTypes
in interfaceAWSDatabaseMigrationService
- Parameters:
describeEndpointTypesRequest
-- Returns:
- Result of the DescribeEndpointTypes operation returned by the service.
-
describeEndpoints
Returns information about the endpoints for your account in the current region.
- Specified by:
describeEndpoints
in interfaceAWSDatabaseMigrationService
- Parameters:
describeEndpointsRequest
-- Returns:
- Result of the DescribeEndpoints operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
describeOrderableReplicationInstances
public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest) Returns information about the replication instance types that can be created in the specified region.
- Specified by:
describeOrderableReplicationInstances
in interfaceAWSDatabaseMigrationService
- Parameters:
describeOrderableReplicationInstancesRequest
-- Returns:
- Result of the DescribeOrderableReplicationInstances operation returned by the service.
-
describeRefreshSchemasStatus
public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest) Returns the status of the RefreshSchemas operation.
- Specified by:
describeRefreshSchemasStatus
in interfaceAWSDatabaseMigrationService
- Parameters:
describeRefreshSchemasStatusRequest
-- Returns:
- Result of the DescribeRefreshSchemasStatus operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.
-
describeReplicationInstances
public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest) Returns information about replication instances for your account in the current region.
- Specified by:
describeReplicationInstances
in interfaceAWSDatabaseMigrationService
- Parameters:
describeReplicationInstancesRequest
-- Returns:
- Result of the DescribeReplicationInstances operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
describeReplicationSubnetGroups
public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest) Returns information about the replication subnet groups.
- Specified by:
describeReplicationSubnetGroups
in interfaceAWSDatabaseMigrationService
- Parameters:
describeReplicationSubnetGroupsRequest
-- Returns:
- Result of the DescribeReplicationSubnetGroups operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
describeReplicationTasks
public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest) Returns information about replication tasks for your account in the current region.
- Specified by:
describeReplicationTasks
in interfaceAWSDatabaseMigrationService
- Parameters:
describeReplicationTasksRequest
-- Returns:
- Result of the DescribeReplicationTasks operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
describeSchemas
Returns information about the schema for the specified endpoint.
- Specified by:
describeSchemas
in interfaceAWSDatabaseMigrationService
- Parameters:
describeSchemasRequest
-- Returns:
- Result of the DescribeSchemas operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.
-
describeTableStatistics
public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest) Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
- Specified by:
describeTableStatistics
in interfaceAWSDatabaseMigrationService
- Parameters:
describeTableStatisticsRequest
-- Returns:
- Result of the DescribeTableStatistics operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags for an AWS DMS resource.
- Specified by:
listTagsForResource
in interfaceAWSDatabaseMigrationService
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
modifyEndpoint
Modifies the specified endpoint.
- Specified by:
modifyEndpoint
in interfaceAWSDatabaseMigrationService
- Parameters:
modifyEndpointRequest
-- Returns:
- Result of the ModifyEndpoint operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.
-
modifyReplicationInstance
public 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. - Specified by:
modifyReplicationInstance
in interfaceAWSDatabaseMigrationService
- Parameters:
modifyReplicationInstanceRequest
-- Returns:
- Result of the ModifyReplicationInstance operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.InsufficientResourceCapacityException
- There are not enough resources allocated to the database migration.StorageQuotaExceededException
- The storage quota has been exceeded.UpgradeDependencyFailureException
- An upgrade dependency is preventing the database migration.
-
modifyReplicationSubnetGroup
public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest) Modifies the settings for the specified replication subnet group.
- Specified by:
modifyReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Parameters:
modifyReplicationSubnetGroupRequest
-- Returns:
- Result of the ModifyReplicationSubnetGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.SubnetAlreadyInUseException
- The specified subnet is already in use.ReplicationSubnetGroupDoesNotCoverEnoughAZsException
- The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.InvalidSubnetException
- The subnet provided is invalid.
-
refreshSchemas
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.
- Specified by:
refreshSchemas
in interfaceAWSDatabaseMigrationService
- Parameters:
refreshSchemasRequest
-- Returns:
- Result of the RefreshSchemas operation returned by the service.
- Throws:
InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.
-
removeTagsFromResource
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from a DMS resource.
- Specified by:
removeTagsFromResource
in interfaceAWSDatabaseMigrationService
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.
-
startReplicationTask
public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest) Starts the replication task.
- Specified by:
startReplicationTask
in interfaceAWSDatabaseMigrationService
- Parameters:
startReplicationTaskRequest
-- Returns:
- Result of the StartReplicationTask operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.
-
stopReplicationTask
public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest) Stops the replication task.
- Specified by:
stopReplicationTask
in interfaceAWSDatabaseMigrationService
- Parameters:
stopReplicationTaskRequest
-- Returns:
- Result of the StopReplicationTask operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.
-
testConnection
Tests the connection between the replication instance and the endpoint.
- Specified by:
testConnection
in interfaceAWSDatabaseMigrationService
- Parameters:
testConnectionRequest
-- Returns:
- Result of the TestConnection operation returned by the service.
- Throws:
ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException
- AWS DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSDatabaseMigrationService
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-