@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSDatabaseMigrationService extends Object implements AWSDatabaseMigrationService
AWSDatabaseMigrationService
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public void setEndpoint(String endpoint)
AWSDatabaseMigrationService
Callers can pass in just the endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "dms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSDatabaseMigrationService
endpoint
- The endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"dms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSDatabaseMigrationService
AWSDatabaseMigrationService.setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSDatabaseMigrationService
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSDatabaseMigrationService
Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.
addTagsToResource
in interface AWSDatabaseMigrationService
request
- Associates a set of tags with an AWS DMS resource.public ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
AWSDatabaseMigrationService
Applies a pending maintenance action to a resource (for example, to a replication instance).
applyPendingMaintenanceAction
in interface AWSDatabaseMigrationService
public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
AWSDatabaseMigrationService
Creates an endpoint using the provided settings.
createEndpoint
in interface AWSDatabaseMigrationService
public CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest request)
AWSDatabaseMigrationService
Creates an AWS DMS event notification subscription.
You can specify the type of source (SourceType
) you want to be notified of, provide a list of AWS
DMS source IDs (SourceIds
) that triggers the events, and provide a list of event categories (
EventCategories
) for events you want to be notified of. If you specify both the
SourceType
and SourceIds
, such as SourceType = replication-instance
and
SourceIdentifier = my-replinstance
, you will be notified of all the replication instance events for
the specified source. If you specify a SourceType
but don't specify a SourceIdentifier
,
you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either
SourceType
nor SourceIdentifier
, you will be notified of events generated from all AWS
DMS sources belonging to your customer account.
For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
createEventSubscription
in interface AWSDatabaseMigrationService
public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)
AWSDatabaseMigrationService
Creates the replication instance using the specified parameters.
AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For information on the required permissions, see IAM Permissions Needed to Use AWS DMS.
createReplicationInstance
in interface AWSDatabaseMigrationService
public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)
AWSDatabaseMigrationService
Creates a replication task using the specified parameters.
createReplicationTask
in interface AWSDatabaseMigrationService
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSDatabaseMigrationService
Deletes the specified certificate.
deleteCertificate
in interface AWSDatabaseMigrationService
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
AWSDatabaseMigrationService
Deletes the connection between a replication instance and an endpoint.
deleteConnection
in interface AWSDatabaseMigrationService
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
AWSDatabaseMigrationService
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpoint
in interface AWSDatabaseMigrationService
public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
AWSDatabaseMigrationService
Deletes an AWS DMS event subscription.
deleteEventSubscription
in interface AWSDatabaseMigrationService
public DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest request)
AWSDatabaseMigrationService
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
deleteReplicationInstance
in interface AWSDatabaseMigrationService
public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Deletes a subnet group.
deleteReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)
AWSDatabaseMigrationService
Deletes the specified replication task.
deleteReplicationTask
in interface AWSDatabaseMigrationService
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
AWSDatabaseMigrationService
Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
describeAccountAttributes
in interface AWSDatabaseMigrationService
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
AWSDatabaseMigrationService
Provides a description of the certificate.
describeCertificates
in interface AWSDatabaseMigrationService
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
AWSDatabaseMigrationService
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 AWSDatabaseMigrationService
public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)
AWSDatabaseMigrationService
Returns information about the type of endpoints available.
describeEndpointTypes
in interface AWSDatabaseMigrationService
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
AWSDatabaseMigrationService
Returns information about the endpoints for your account in the current region.
describeEndpoints
in interface AWSDatabaseMigrationService
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
AWSDatabaseMigrationService
Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
describeEventCategories
in interface AWSDatabaseMigrationService
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
AWSDatabaseMigrationService
Lists all the event subscriptions for a customer account. The description of a subscription includes
SubscriptionName
, SNSTopicARN
, CustomerID
, SourceType
,
SourceID
, CreationTime
, and Status
.
If you specify SubscriptionName
, this action lists the description for that subscription.
describeEventSubscriptions
in interface AWSDatabaseMigrationService
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AWSDatabaseMigrationService
Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
describeEvents
in interface AWSDatabaseMigrationService
public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
AWSDatabaseMigrationService
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstances
in interface AWSDatabaseMigrationService
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
AWSDatabaseMigrationService
For internal use only
describePendingMaintenanceActions
in interface AWSDatabaseMigrationService
public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
AWSDatabaseMigrationService
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatus
in interface AWSDatabaseMigrationService
public DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)
AWSDatabaseMigrationService
Returns information about the task logs for the specified task.
describeReplicationInstanceTaskLogs
in interface AWSDatabaseMigrationService
public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)
AWSDatabaseMigrationService
Returns information about replication instances for your account in the current region.
describeReplicationInstances
in interface AWSDatabaseMigrationService
public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
AWSDatabaseMigrationService
Returns information about the replication subnet groups.
describeReplicationSubnetGroups
in interface AWSDatabaseMigrationService
public DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)
AWSDatabaseMigrationService
Returns the task assessment results from Amazon S3. This action always returns the latest results.
describeReplicationTaskAssessmentResults
in interface AWSDatabaseMigrationService
public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)
AWSDatabaseMigrationService
Returns information about replication tasks for your account in the current region.
describeReplicationTasks
in interface AWSDatabaseMigrationService
public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)
AWSDatabaseMigrationService
Returns information about the schema for the specified endpoint.
describeSchemas
in interface AWSDatabaseMigrationService
public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest request)
AWSDatabaseMigrationService
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
describeTableStatistics
in interface AWSDatabaseMigrationService
public ImportCertificateResult importCertificate(ImportCertificateRequest request)
AWSDatabaseMigrationService
Uploads the specified certificate.
importCertificate
in interface AWSDatabaseMigrationService
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSDatabaseMigrationService
Lists all tags for an AWS DMS resource.
listTagsForResource
in interface AWSDatabaseMigrationService
public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)
AWSDatabaseMigrationService
Modifies the specified endpoint.
modifyEndpoint
in interface AWSDatabaseMigrationService
public ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest request)
AWSDatabaseMigrationService
Modifies an existing AWS DMS event notification subscription.
modifyEventSubscription
in interface AWSDatabaseMigrationService
public ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest request)
AWSDatabaseMigrationService
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
modifyReplicationInstance
in interface AWSDatabaseMigrationService
public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest request)
AWSDatabaseMigrationService
Modifies the specified replication task.
You can't modify the task endpoints. The task must be stopped before you can modify it.
For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
modifyReplicationTask
in interface AWSDatabaseMigrationService
public RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest request)
AWSDatabaseMigrationService
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
rebootReplicationInstance
in interface AWSDatabaseMigrationService
public RefreshSchemasResult refreshSchemas(RefreshSchemasRequest request)
AWSDatabaseMigrationService
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 AWSDatabaseMigrationService
public ReloadTablesResult reloadTables(ReloadTablesRequest request)
AWSDatabaseMigrationService
Reloads the target database table with the source data.
reloadTables
in interface AWSDatabaseMigrationService
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSDatabaseMigrationService
Removes metadata tags from a DMS resource.
removeTagsFromResource
in interface AWSDatabaseMigrationService
request
- Removes one or more tags from an AWS DMS resource.public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)
AWSDatabaseMigrationService
Starts the replication task.
For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
startReplicationTask
in interface AWSDatabaseMigrationService
public StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)
AWSDatabaseMigrationService
Starts the replication task assessment for unsupported data types in the source database.
startReplicationTaskAssessment
in interface AWSDatabaseMigrationService
public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)
AWSDatabaseMigrationService
Stops the replication task.
stopReplicationTask
in interface AWSDatabaseMigrationService
public TestConnectionResult testConnection(TestConnectionRequest request)
AWSDatabaseMigrationService
Tests the connection between the replication instance and the endpoint.
testConnection
in interface AWSDatabaseMigrationService
public void shutdown()
AWSDatabaseMigrationService
shutdown
in interface AWSDatabaseMigrationService
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSDatabaseMigrationService
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSDatabaseMigrationService
request
- The originally executed request.public AWSDatabaseMigrationServiceWaiters waiters()
waiters
in interface AWSDatabaseMigrationService
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.