com.amazonaws.services.databasemigrationservice

Class AWSDatabaseMigrationServiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.databasemigrationservice.AWSDatabaseMigrationServiceClient

All Implemented Interfaces:

AWSDatabaseMigrationService

Direct Known Subclasses:

AWSDatabaseMigrationServiceAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSDatabaseMigrationServiceClient
extends AmazonWebServiceClient
implements AWSDatabaseMigrationService

Client for accessing AWS Database Migration Service. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Database Migration Service

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, 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 the AWS DMS user guide at What Is AWS Database Migration Service?

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.databasemigrationservice.AWSDatabaseMigrationService

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSDatabaseMigrationServiceClient() Deprecated. use AWSDatabaseMigrationServiceClientBuilder.defaultClient()
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDatabaseMigrationServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSDatabaseMigrationServiceClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest request) Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.
static AWSDatabaseMigrationServiceClientBuilder	builder()
CreateEndpointResult	createEndpoint(CreateEndpointRequest request) Creates an endpoint using the provided settings.
CreateEventSubscriptionResult	createEventSubscription(CreateEventSubscriptionRequest request) Creates an AWS DMS event notification subscription.
CreateReplicationInstanceResult	createReplicationInstance(CreateReplicationInstanceRequest request) Creates the replication instance using the specified parameters.
CreateReplicationSubnetGroupResult	createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request) Creates a replication subnet group given a list of the subnet IDs in a VPC.
CreateReplicationTaskResult	createReplicationTask(CreateReplicationTaskRequest request) Creates a replication task using the specified parameters.
DeleteCertificateResult	deleteCertificate(DeleteCertificateRequest request) Deletes the specified certificate.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest request) Deletes the specified endpoint.
DeleteEventSubscriptionResult	deleteEventSubscription(DeleteEventSubscriptionRequest request) Deletes an AWS DMS event subscription.
DeleteReplicationInstanceResult	deleteReplicationInstance(DeleteReplicationInstanceRequest request) Deletes the specified replication instance.
DeleteReplicationSubnetGroupResult	deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request) Deletes a subnet group.
DeleteReplicationTaskResult	deleteReplicationTask(DeleteReplicationTaskRequest request) Deletes the specified replication task.
DescribeAccountAttributesResult	describeAccountAttributes(DescribeAccountAttributesRequest request) Lists all of the AWS DMS attributes for a customer account.
DescribeCertificatesResult	describeCertificates(DescribeCertificatesRequest request) Provides a description of the certificate.
DescribeConnectionsResult	describeConnections(DescribeConnectionsRequest request) Describes the status of the connections that have been made between the replication instance and an endpoint.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest request) Returns information about the endpoints for your account in the current region.
DescribeEndpointTypesResult	describeEndpointTypes(DescribeEndpointTypesRequest request) Returns information about the type of endpoints available.
DescribeEventCategoriesResult	describeEventCategories(DescribeEventCategoriesRequest request) Lists categories for all event source types, or, if specified, for a specified source type.
DescribeEventsResult	describeEvents(DescribeEventsRequest request) Lists events for a given source identifier and source type.
DescribeEventSubscriptionsResult	describeEventSubscriptions(DescribeEventSubscriptionsRequest request) Lists all the event subscriptions for a customer account.
DescribeOrderableReplicationInstancesResult	describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request) Returns information about the replication instance types that can be created in the specified region.
DescribeRefreshSchemasStatusResult	describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request) Returns the status of the RefreshSchemas operation.
DescribeReplicationInstancesResult	describeReplicationInstances(DescribeReplicationInstancesRequest request) Returns information about replication instances for your account in the current region.
DescribeReplicationSubnetGroupsResult	describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request) Returns information about the replication subnet groups.
DescribeReplicationTasksResult	describeReplicationTasks(DescribeReplicationTasksRequest request) Returns information about replication tasks for your account in the current region.
DescribeSchemasResult	describeSchemas(DescribeSchemasRequest request) Returns information about the schema for the specified endpoint.
DescribeTableStatisticsResult	describeTableStatistics(DescribeTableStatisticsRequest request) Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ImportCertificateResult	importCertificate(ImportCertificateRequest request) Uploads the specified certificate.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags for an AWS DMS resource.
ModifyEndpointResult	modifyEndpoint(ModifyEndpointRequest request) Modifies the specified endpoint.
ModifyEventSubscriptionResult	modifyEventSubscription(ModifyEventSubscriptionRequest request) Modifies an existing AWS DMS event notification subscription.
ModifyReplicationInstanceResult	modifyReplicationInstance(ModifyReplicationInstanceRequest request) Modifies the replication instance to apply new settings.
ModifyReplicationSubnetGroupResult	modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request) Modifies the settings for the specified replication subnet group.
ModifyReplicationTaskResult	modifyReplicationTask(ModifyReplicationTaskRequest request) Modifies the specified replication task.
RefreshSchemasResult	refreshSchemas(RefreshSchemasRequest request) Populates the schema for the specified endpoint.
ReloadTablesResult	reloadTables(ReloadTablesRequest request) Reloads the target database table with the source data.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest request) Removes metadata tags from a DMS resource.
StartReplicationTaskResult	startReplicationTask(StartReplicationTaskRequest request) Starts the replication task.
StopReplicationTaskResult	stopReplicationTask(StopReplicationTaskRequest request) Stops the replication task.
TestConnectionResult	testConnection(TestConnectionRequest request) Tests the connection between the replication instance and the endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.databasemigrationservice.AWSDatabaseMigrationService

setEndpoint, setRegion, shutdown

Constructor Detail

AWSDatabaseMigrationServiceClient

@Deprecated
public AWSDatabaseMigrationServiceClient()

Deprecated. use AWSDatabaseMigrationServiceClientBuilder.defaultClient()

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:

DefaultAWSCredentialsProviderChain

AWSDatabaseMigrationServiceClient

@Deprecated
public AWSDatabaseMigrationServiceClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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:

DefaultAWSCredentialsProviderChain

AWSDatabaseMigrationServiceClient

@Deprecated
public AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDatabaseMigrationServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

@Deprecated
public AWSDatabaseMigrationServiceClient(AWSCredentials awsCredentials,
                                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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

@Deprecated
public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSDatabaseMigrationServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                                     ClientConfiguration clientConfiguration,
                                                     RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(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 Detail

builder

public static AWSDatabaseMigrationServiceClientBuilder builder()

addTagsToResource

public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)

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 interface AWSDatabaseMigrationService

Parameters:

addTagsToResourceRequest -

Returns:

Result of the AddTagsToResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

createEndpoint

public CreateEndpointResult createEndpoint(CreateEndpointRequest request)

Creates an endpoint using the provided settings.

Specified by:

createEndpoint in interface AWSDatabaseMigrationService

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.

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.

See Also:

AWS API Documentation

createEventSubscription

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.

Specified by:

createEventSubscription in interface AWSDatabaseMigrationService

Parameters:

createEventSubscriptionRequest -

Returns:

Result of the CreateEventSubscription operation returned by the service.

Throws:

ResourceQuotaExceededException - The quota for this resource quota has been exceeded.

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.

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

createReplicationInstance

public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)

Creates the replication instance using the specified parameters.

Specified by:

createReplicationInstance in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

createReplicationSubnetGroup

public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)

Creates a replication subnet group given a list of the subnet IDs in a VPC.

Specified by:

createReplicationSubnetGroup in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

createReplicationTask

public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)

Creates a replication task using the specified parameters.

Specified by:

createReplicationTask in interface AWSDatabaseMigrationService

Parameters:

createReplicationTaskRequest -

Returns:

Result of the CreateReplicationTask operation returned by the service.

Throws:

AccessDeniedException - AWS DMS was denied access to the endpoint.

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.

See Also:

AWS API Documentation

deleteCertificate

public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)

Deletes the specified certificate.

Specified by:

deleteCertificate in interface AWSDatabaseMigrationService

Parameters:

deleteCertificateRequest -

Returns:

Result of the DeleteCertificate 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.

See Also:

AWS API Documentation

deleteEndpoint

public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

Specified by:

deleteEndpoint in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

deleteEventSubscription

public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)

Deletes an AWS DMS event subscription.

Specified by:

deleteEventSubscription in interface AWSDatabaseMigrationService

Parameters:

deleteEventSubscriptionRequest -

Returns:

Result of the DeleteEventSubscription 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.

See Also:

AWS API Documentation

deleteReplicationInstance

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.

Specified by:

deleteReplicationInstance in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

deleteReplicationSubnetGroup

public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)

Deletes a subnet group.

Specified by:

deleteReplicationSubnetGroup in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

deleteReplicationTask

public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)

Deletes the specified replication task.

Specified by:

deleteReplicationTask in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)

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 interface AWSDatabaseMigrationService

Parameters:

describeAccountAttributesRequest -

Returns:

Result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeCertificates

public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)

Provides a description of the certificate.

Specified by:

describeCertificates in interface AWSDatabaseMigrationService

Parameters:

describeCertificatesRequest -

Returns:

Result of the DescribeCertificates operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeConnections

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.

Specified by:

describeConnections in interface AWSDatabaseMigrationService

Parameters:

describeConnectionsRequest -

Returns:

Result of the DescribeConnections operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEndpointTypes

public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)

Returns information about the type of endpoints available.

Specified by:

describeEndpointTypes in interface AWSDatabaseMigrationService

Parameters:

describeEndpointTypesRequest -

Returns:

Result of the DescribeEndpointTypes operation returned by the service.

See Also:

AWS API Documentation

describeEndpoints

public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)

Returns information about the endpoints for your account in the current region.

Specified by:

describeEndpoints in interface AWSDatabaseMigrationService

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEventCategories

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.

Specified by:

describeEventCategories in interface AWSDatabaseMigrationService

Parameters:

describeEventCategoriesRequest -

Returns:

Result of the DescribeEventCategories operation returned by the service.

See Also:

AWS API Documentation

describeEventSubscriptions

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.

Specified by:

describeEventSubscriptions in interface AWSDatabaseMigrationService

Parameters:

describeEventSubscriptionsRequest -

Returns:

Result of the DescribeEventSubscriptions operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeEvents

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 .

Specified by:

describeEvents in interface AWSDatabaseMigrationService

Parameters:

describeEventsRequest -

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeOrderableReplicationInstances

public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)

Returns information about the replication instance types that can be created in the specified region.

Specified by:

describeOrderableReplicationInstances in interface AWSDatabaseMigrationService

Parameters:

describeOrderableReplicationInstancesRequest -

Returns:

Result of the DescribeOrderableReplicationInstances operation returned by the service.

See Also:

AWS API Documentation

describeRefreshSchemasStatus

public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)

Returns the status of the RefreshSchemas operation.

Specified by:

describeRefreshSchemasStatus in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

describeReplicationInstances

public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)

Returns information about replication instances for your account in the current region.

Specified by:

describeReplicationInstances in interface AWSDatabaseMigrationService

Parameters:

describeReplicationInstancesRequest -

Returns:

Result of the DescribeReplicationInstances operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeReplicationSubnetGroups

public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)

Returns information about the replication subnet groups.

Specified by:

describeReplicationSubnetGroups in interface AWSDatabaseMigrationService

Parameters:

describeReplicationSubnetGroupsRequest -

Returns:

Result of the DescribeReplicationSubnetGroups operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeReplicationTasks

public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)

Returns information about replication tasks for your account in the current region.

Specified by:

describeReplicationTasks in interface AWSDatabaseMigrationService

Parameters:

describeReplicationTasksRequest -

Returns:

Result of the DescribeReplicationTasks operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

describeSchemas

public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)

Returns information about the schema for the specified endpoint.

Specified by:

describeSchemas in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

describeTableStatistics

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.

Specified by:

describeTableStatistics in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

importCertificate

public ImportCertificateResult importCertificate(ImportCertificateRequest request)

Uploads the specified certificate.

Specified by:

importCertificate in interface AWSDatabaseMigrationService

Parameters:

importCertificateRequest -

Returns:

Result of the ImportCertificate operation returned by the service.

Throws:

ResourceAlreadyExistsException - The resource you are attempting to create already exists.

InvalidCertificateException - The certificate was not valid.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags for an AWS DMS resource.

Specified by:

listTagsForResource in interface AWSDatabaseMigrationService

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

modifyEndpoint

public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)

Modifies the specified endpoint.

Specified by:

modifyEndpoint in interface AWSDatabaseMigrationService

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.

AccessDeniedException - AWS DMS was denied access to the endpoint.

See Also:

AWS API Documentation

modifyEventSubscription

public ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest request)

Modifies an existing AWS DMS event notification subscription.

Specified by:

modifyEventSubscription in interface AWSDatabaseMigrationService

Parameters:

modifyEventSubscriptionRequest -

Returns:

Result of the ModifyEventSubscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

modifyReplicationInstance

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.

Specified by:

modifyReplicationInstance in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

modifyReplicationSubnetGroup

public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)

Modifies the settings for the specified replication subnet group.

Specified by:

modifyReplicationSubnetGroup in interface AWSDatabaseMigrationService

Parameters:

modifyReplicationSubnetGroupRequest -

Returns:

Result of the ModifyReplicationSubnetGroup operation returned by the service.

Throws:

AccessDeniedException - AWS DMS was denied access to the endpoint.

ResourceNotFoundException - The resource could not be found.

ResourceQuotaExceededException - The quota for this resource quota has been exceeded.

SubnetAlreadyInUseException - The specified subnet is already in use.

ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

InvalidSubnetException - The subnet provided is invalid.

See Also:

AWS API Documentation

modifyReplicationTask

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 the AWS DMS user guide at Working with Migration Tasks

Specified by:

modifyReplicationTask in interface AWSDatabaseMigrationService

Parameters:

modifyReplicationTaskRequest -

Returns:

Result of the ModifyReplicationTask 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.

See Also:

AWS API Documentation

refreshSchemas

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.

Specified by:

refreshSchemas in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

reloadTables

public ReloadTablesResult reloadTables(ReloadTablesRequest request)

Reloads the target database table with the source data.

Specified by:

reloadTables in interface AWSDatabaseMigrationService

Parameters:

reloadTablesRequest -

Returns:

Result of the ReloadTables 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.

See Also:

AWS API Documentation

removeTagsFromResource

public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)

Removes metadata tags from a DMS resource.

Specified by:

removeTagsFromResource in interface AWSDatabaseMigrationService

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

See Also:

AWS API Documentation

startReplicationTask

public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)

Starts the replication task.

For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks

Specified by:

startReplicationTask in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

stopReplicationTask

public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)

Stops the replication task.

Specified by:

stopReplicationTask in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

testConnection

public TestConnectionResult testConnection(TestConnectionRequest request)

Tests the connection between the replication instance and the endpoint.

Specified by:

testConnection in interface AWSDatabaseMigrationService

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSDatabaseMigrationService

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.