AbstractAWSDatabaseMigrationService (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.AbstractAWSDatabaseMigrationService

All Implemented Interfaces:

AWSDatabaseMigrationService

Direct Known Subclasses:

AbstractAWSDatabaseMigrationServiceAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSDatabaseMigrationService
extends Object
implements AWSDatabaseMigrationService
```
Abstract implementation of AWSDatabaseMigrationService. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.databasemigrationservice.AWSDatabaseMigrationService
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest request)` Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task.
`ApplyPendingMaintenanceActionResult`	`applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)` Applies a pending maintenance action to a resource (for example, to a replication instance).
`CancelReplicationTaskAssessmentRunResult`	`cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest request)` Cancels a single premigration assessment run.
`CreateEndpointResult`	`createEndpoint(CreateEndpointRequest request)` Creates an endpoint using the provided settings.
`CreateEventSubscriptionResult`	`createEventSubscription(CreateEventSubscriptionRequest request)` Creates an 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.
`DeleteConnectionResult`	`deleteConnection(DeleteConnectionRequest request)` Deletes the connection between a replication instance and an endpoint.
`DeleteEndpointResult`	`deleteEndpoint(DeleteEndpointRequest request)` Deletes the specified endpoint.
`DeleteEventSubscriptionResult`	`deleteEventSubscription(DeleteEventSubscriptionRequest request)` Deletes an 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.
`DeleteReplicationTaskAssessmentRunResult`	`deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest request)` Deletes the record of a single premigration assessment run.
`DescribeAccountAttributesResult`	`describeAccountAttributes(DescribeAccountAttributesRequest request)` Lists all of the DMS attributes for a customer account.
`DescribeApplicableIndividualAssessmentsResult`	`describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest request)` Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
`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.
`DescribeEndpointSettingsResult`	`describeEndpointSettings(DescribeEndpointSettingsRequest request)` Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
`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.
`DescribePendingMaintenanceActionsResult`	`describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)` For internal use only
`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.
`DescribeReplicationInstanceTaskLogsResult`	`describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)` Returns information about the task logs for the specified task.
`DescribeReplicationSubnetGroupsResult`	`describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)` Returns information about the replication subnet groups.
`DescribeReplicationTaskAssessmentResultsResult`	`describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)` Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account.
`DescribeReplicationTaskAssessmentRunsResult`	`describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest request)` Returns a paginated list of premigration assessment runs based on filter settings.
`DescribeReplicationTaskIndividualAssessmentsResult`	`describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest request)` Returns a paginated list of individual assessments based on filter settings.
`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 metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task.
`ModifyEndpointResult`	`modifyEndpoint(ModifyEndpointRequest request)` Modifies the specified endpoint.
`ModifyEventSubscriptionResult`	`modifyEventSubscription(ModifyEventSubscriptionRequest request)` Modifies an existing 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.
`MoveReplicationTaskResult`	`moveReplicationTask(MoveReplicationTaskRequest request)` Moves a replication task from its current replication instance to a different target replication instance using the specified parameters.
`RebootReplicationInstanceResult`	`rebootReplicationInstance(RebootReplicationInstanceRequest request)` Reboots a replication instance.
`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 an DMS resource, including replication instance, endpoint, security group, and migration task.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSDatabaseMigrationService.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartReplicationTaskResult`	`startReplicationTask(StartReplicationTaskRequest request)` Starts the replication task.
`StartReplicationTaskAssessmentResult`	`startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)` Starts the replication task assessment for unsupported data types in the source database.
`StartReplicationTaskAssessmentRunResult`	`startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest request)` Starts a new premigration assessment run for one or more individual assessments of a migration task.
`StopReplicationTaskResult`	`stopReplicationTask(StopReplicationTaskRequest request)` Stops the replication task.
`TestConnectionResult`	`testConnection(TestConnectionRequest request)` Tests the connection between the replication instance and the endpoint.
`AWSDatabaseMigrationServiceWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    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.
    
    Specified by:
    
    setEndpoint in interface AWSDatabaseMigrationService
    
    Parameters:
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    An alternative to 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.
    
    Specified by:
    
    setRegion in interface AWSDatabaseMigrationService
    
    Parameters:
    
    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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTagsToResource
```
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Adds metadata tags to an 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. For more information, see Tag data type description.
    
    Specified by:
    
    addTagsToResource in interface AWSDatabaseMigrationService
    
    Parameters:
    
    request - Associates a set of tags with an DMS resource.
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - applyPendingMaintenanceAction
```
public ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Applies a pending maintenance action to a resource (for example, to a replication instance).
    
    Specified by:
    
    applyPendingMaintenanceAction in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ApplyPendingMaintenanceAction operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelReplicationTaskAssessmentRun
```
public CancelReplicationTaskAssessmentRunResult cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Cancels a single premigration assessment run.
    
    This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
    
    Specified by:
    
    cancelReplicationTaskAssessmentRun in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CancelReplicationTaskAssessmentRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEndpoint
```
public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Creates an endpoint using the provided settings.
    
    For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
    
    Specified by:
    
    createEndpoint in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CreateEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEventSubscription
```
public CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Creates an DMS event notification subscription.
    
    You can specify the type of source (SourceType) you want to be notified of, provide a list of 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 DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.
    
    For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
    
    Specified by:
    
    createEventSubscription in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CreateEventSubscription operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationInstance
```
public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Creates the replication instance using the specified parameters.
    
    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 CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
    
    Specified by:
    
    createReplicationInstance in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CreateReplicationInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationSubnetGroup
```
public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Creates a replication subnet group given a list of the subnet IDs in a VPC.
    
    The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
    
    Specified by:
    
    createReplicationSubnetGroup in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CreateReplicationSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationTask
```
public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Creates a replication task using the specified parameters.
    
    Specified by:
    
    createReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the CreateReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCertificate
```
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes the specified certificate.
    
    Specified by:
    
    deleteCertificate in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConnection
```
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes the connection between a replication instance and an endpoint.
    
    Specified by:
    
    deleteConnection in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEndpoint
```
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    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
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEventSubscription
```
public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes an DMS event subscription.
    
    Specified by:
    
    deleteEventSubscription in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteEventSubscription operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationInstance
```
public DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    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
    
    Returns:
    
    Result of the DeleteReplicationInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationSubnetGroup
```
public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes a subnet group.
    
    Specified by:
    
    deleteReplicationSubnetGroup in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteReplicationSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationTask
```
public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes the specified replication task.
    
    Specified by:
    
    deleteReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationTaskAssessmentRun
```
public DeleteReplicationTaskAssessmentRunResult deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Deletes the record of a single premigration assessment run.
    
    This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
    
    Specified by:
    
    deleteReplicationTaskAssessmentRun in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DeleteReplicationTaskAssessmentRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccountAttributes
```
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Lists all of the DMS attributes for a customer account. These attributes include 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.
    
    Specified by:
    
    describeAccountAttributes in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeAccountAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApplicableIndividualAssessments
```
public DescribeApplicableIndividualAssessmentsResult describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
    
    If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.
    
    To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.
    
    If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
    
    Specified by:
    
    describeApplicableIndividualAssessments in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeApplicableIndividualAssessments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCertificates
```
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Provides a description of the certificate.
    
    Specified by:
    
    describeCertificates in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeCertificates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConnections
```
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    describeConnections in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeConnections operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpointSettings
```
public DescribeEndpointSettingsResult describeEndpointSettings(DescribeEndpointSettingsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
    
    Specified by:
    
    describeEndpointSettings in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEndpointSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpointTypes
```
public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the type of endpoints available.
    
    Specified by:
    
    describeEndpointTypes in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEndpointTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpoints
```
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the endpoints for your account in the current region.
    
    Specified by:
    
    describeEndpoints in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEndpoints operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventCategories
```
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
```
    Description copied from interface: 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 Database Migration Service User Guide.
    
    Specified by:
    
    describeEventCategories in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEventCategories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventSubscriptions
```
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    describeEventSubscriptions in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEventSubscriptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
    
    Specified by:
    
    describeEvents in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeOrderableReplicationInstances
```
public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the replication instance types that can be created in the specified region.
    
    Specified by:
    
    describeOrderableReplicationInstances in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeOrderableReplicationInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePendingMaintenanceActions
```
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    For internal use only
    
    Specified by:
    
    describePendingMaintenanceActions in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribePendingMaintenanceActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRefreshSchemasStatus
```
public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns the status of the RefreshSchemas operation.
    
    Specified by:
    
    describeRefreshSchemasStatus in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeRefreshSchemasStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationInstanceTaskLogs
```
public DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the task logs for the specified task.
    
    Specified by:
    
    describeReplicationInstanceTaskLogs in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationInstanceTaskLogs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationInstances
```
public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about replication instances for your account in the current region.
    
    Specified by:
    
    describeReplicationInstances in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationSubnetGroups
```
public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the replication subnet groups.
    
    Specified by:
    
    describeReplicationSubnetGroups in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationSubnetGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationTaskAssessmentResults
```
public DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.
    
    For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
    
    Specified by:
    
    describeReplicationTaskAssessmentResults in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationTaskAssessmentResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationTaskAssessmentRuns
```
public DescribeReplicationTaskAssessmentRunsResult describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns a paginated list of premigration assessment runs based on filter settings.
    
    These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
    
    This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
    
    Specified by:
    
    describeReplicationTaskAssessmentRuns in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationTaskAssessmentRuns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationTaskIndividualAssessments
```
public DescribeReplicationTaskIndividualAssessmentsResult describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns a paginated list of individual assessments based on filter settings.
    
    These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
    
    Specified by:
    
    describeReplicationTaskIndividualAssessments in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationTaskIndividualAssessments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationTasks
```
public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about replication tasks for your account in the current region.
    
    Specified by:
    
    describeReplicationTasks in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeReplicationTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSchemas
```
public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Returns information about the schema for the specified endpoint.
    
    Specified by:
    
    describeSchemas in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the DescribeSchemas operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTableStatistics
```
public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest request)
```
    Description copied from interface: 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 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
    
    Returns:
    
    Result of the DescribeTableStatistics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importCertificate
```
public ImportCertificateResult importCertificate(ImportCertificateRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Uploads the specified certificate.
    
    Specified by:
    
    importCertificate in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ImportCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
    
    Specified by:
    
    listTagsForResource in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyEndpoint
```
public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Modifies the specified endpoint.
    
    For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
    
    Specified by:
    
    modifyEndpoint in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ModifyEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyEventSubscription
```
public ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Modifies an existing DMS event notification subscription.
    
    Specified by:
    
    modifyEventSubscription in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ModifyEventSubscription operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationInstance
```
public ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    modifyReplicationInstance in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ModifyReplicationInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationSubnetGroup
```
public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Modifies the settings for the specified replication subnet group.
    
    Specified by:
    
    modifyReplicationSubnetGroup in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ModifyReplicationSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationTask
```
public ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest request)
```
    Description copied from interface: 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 DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
    
    Specified by:
    
    modifyReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ModifyReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - moveReplicationTask
```
public MoveReplicationTaskResult moveReplicationTask(MoveReplicationTaskRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
    
    Specified by:
    
    moveReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the MoveReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootReplicationInstance
```
public RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
    
    Specified by:
    
    rebootReplicationInstance in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the RebootReplicationInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - refreshSchemas
```
public RefreshSchemasResult refreshSchemas(RefreshSchemasRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    refreshSchemas in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the RefreshSchemas operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - reloadTables
```
public ReloadTablesResult reloadTables(ReloadTablesRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Reloads the target database table with the source data.
    
    You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.
    
    Specified by:
    
    reloadTables in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the ReloadTables operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromResource
```
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
    
    Specified by:
    
    removeTagsFromResource in interface AWSDatabaseMigrationService
    
    Parameters:
    
    request - Removes one or more tags from an DMS resource.
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReplicationTask
```
public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Starts the replication task.
    
    For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
    
    Specified by:
    
    startReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the StartReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReplicationTaskAssessment
```
public StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Starts the replication task assessment for unsupported data types in the source database.
    
    Specified by:
    
    startReplicationTaskAssessment in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the StartReplicationTaskAssessment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReplicationTaskAssessmentRun
```
public StartReplicationTaskAssessmentRunResult startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Starts a new premigration assessment run for one or more individual assessments of a migration task.
    
    The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
    
    Specified by:
    
    startReplicationTaskAssessmentRun in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the StartReplicationTaskAssessmentRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopReplicationTask
```
public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Stops the replication task.
    
    Specified by:
    
    stopReplicationTask in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the StopReplicationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testConnection
```
public TestConnectionResult testConnection(TestConnectionRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Tests the connection between the replication instance and the endpoint.
    
    Specified by:
    
    testConnection in interface AWSDatabaseMigrationService
    
    Returns:
    
    Result of the TestConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSDatabaseMigrationService
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSDatabaseMigrationService
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSDatabaseMigrationService
    
    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 a 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.
  - waiters
```
public AWSDatabaseMigrationServiceWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSDatabaseMigrationService

Did this page help you?

Class AbstractAWSDatabaseMigrationService

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTagsToResource

applyPendingMaintenanceAction

cancelReplicationTaskAssessmentRun

createEndpoint

createEventSubscription

createReplicationInstance

createReplicationSubnetGroup

createReplicationTask

deleteCertificate

deleteConnection

deleteEndpoint

deleteEventSubscription

deleteReplicationInstance

deleteReplicationSubnetGroup

deleteReplicationTask

deleteReplicationTaskAssessmentRun

describeAccountAttributes

describeApplicableIndividualAssessments

describeCertificates

describeConnections

describeEndpointSettings

describeEndpointTypes

describeEndpoints

describeEventCategories

describeEventSubscriptions

describeEvents

describeOrderableReplicationInstances

describePendingMaintenanceActions

describeRefreshSchemasStatus

describeReplicationInstanceTaskLogs

describeReplicationInstances

describeReplicationSubnetGroups

describeReplicationTaskAssessmentResults

describeReplicationTaskAssessmentRuns

describeReplicationTaskIndividualAssessments

describeReplicationTasks

describeSchemas

describeTableStatistics

importCertificate

listTagsForResource

modifyEndpoint

modifyEventSubscription

modifyReplicationInstance

modifyReplicationSubnetGroup

modifyReplicationTask

moveReplicationTask

rebootReplicationInstance

refreshSchemas

reloadTables

removeTagsFromResource

startReplicationTask

startReplicationTaskAssessment

startReplicationTaskAssessmentRun

stopReplicationTask

testConnection

shutdown

getCachedResponseMetadata

waiters