@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDatabaseMigrationService
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDatabaseMigrationService
instead.
Database Migration Service (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 DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration
task.
|
ApplyPendingMaintenanceActionResult |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a replication instance).
|
BatchStartRecommendationsResult |
batchStartRecommendations(BatchStartRecommendationsRequest batchStartRecommendationsRequest)
Starts the analysis of up to 20 source databases to recommend target engines for each source database.
|
CancelReplicationTaskAssessmentRunResult |
cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest cancelReplicationTaskAssessmentRunRequest)
Cancels a single premigration assessment run.
|
CreateDataProviderResult |
createDataProvider(CreateDataProviderRequest createDataProviderRequest)
Creates a data provider using the provided settings.
|
CreateEndpointResult |
createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates an endpoint using the provided settings.
|
CreateEventSubscriptionResult |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an DMS event notification subscription.
|
CreateFleetAdvisorCollectorResult |
createFleetAdvisorCollector(CreateFleetAdvisorCollectorRequest createFleetAdvisorCollectorRequest)
Creates a Fleet Advisor collector using the specified parameters.
|
CreateInstanceProfileResult |
createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates the instance profile using the specified parameters.
|
CreateMigrationProjectResult |
createMigrationProject(CreateMigrationProjectRequest createMigrationProjectRequest)
Creates the migration project using the specified parameters.
|
CreateReplicationConfigResult |
createReplicationConfig(CreateReplicationConfigRequest createReplicationConfigRequest)
Creates a configuration that you can later provide to configure and start an DMS Serverless replication.
|
CreateReplicationInstanceResult |
createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)
Creates the replication instance using the specified parameters.
|
CreateReplicationSubnetGroupResult |
createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)
Creates a replication subnet group given a list of the subnet IDs in a VPC.
|
CreateReplicationTaskResult |
createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)
Creates a replication task using the specified parameters.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
Deletes the connection between a replication instance and an endpoint.
|
DeleteDataProviderResult |
deleteDataProvider(DeleteDataProviderRequest deleteDataProviderRequest)
Deletes the specified data provider.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the specified endpoint.
|
DeleteEventSubscriptionResult |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an DMS event subscription.
|
DeleteFleetAdvisorCollectorResult |
deleteFleetAdvisorCollector(DeleteFleetAdvisorCollectorRequest deleteFleetAdvisorCollectorRequest)
Deletes the specified Fleet Advisor collector.
|
DeleteFleetAdvisorDatabasesResult |
deleteFleetAdvisorDatabases(DeleteFleetAdvisorDatabasesRequest deleteFleetAdvisorDatabasesRequest)
Deletes the specified Fleet Advisor collector databases.
|
DeleteInstanceProfileResult |
deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile.
|
DeleteMigrationProjectResult |
deleteMigrationProject(DeleteMigrationProjectRequest deleteMigrationProjectRequest)
Deletes the specified migration project.
|
DeleteReplicationConfigResult |
deleteReplicationConfig(DeleteReplicationConfigRequest deleteReplicationConfigRequest)
Deletes an DMS Serverless replication configuration.
|
DeleteReplicationInstanceResult |
deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)
Deletes the specified replication instance.
|
DeleteReplicationSubnetGroupResult |
deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)
Deletes a subnet group.
|
DeleteReplicationTaskResult |
deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)
Deletes the specified replication task.
|
DeleteReplicationTaskAssessmentRunResult |
deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest deleteReplicationTaskAssessmentRunRequest)
Deletes the record of a single premigration assessment run.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Lists all of the DMS attributes for a customer account.
|
DescribeApplicableIndividualAssessmentsResult |
describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest describeApplicableIndividualAssessmentsRequest)
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one
or more parameters.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Provides a description of the certificate.
|
DescribeConnectionsResult |
describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
Describes the status of the connections that have been made between the replication instance and an endpoint.
|
DescribeConversionConfigurationResult |
describeConversionConfiguration(DescribeConversionConfigurationRequest describeConversionConfigurationRequest)
Returns configuration parameters for a schema conversion project.
|
DescribeDataProvidersResult |
describeDataProviders(DescribeDataProvidersRequest describeDataProvidersRequest)
Returns a paginated list of data providers for your account in the current region.
|
DescribeEndpointsResult |
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns information about the endpoints for your account in the current region.
|
DescribeEndpointSettingsResult |
describeEndpointSettings(DescribeEndpointSettingsRequest describeEndpointSettingsRequest)
Returns information about the possible endpoint settings available when you create an endpoint for a specific
database engine.
|
DescribeEndpointTypesResult |
describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)
Returns information about the type of endpoints available.
|
DescribeEngineVersionsResult |
describeEngineVersions(DescribeEngineVersionsRequest describeEngineVersionsRequest)
Returns information about the replication instance versions used in the project.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Lists categories for all event source types, or, if specified, for a specified source type.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Lists events for a given source identifier and source type.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the event subscriptions for a customer account.
|
DescribeExtensionPackAssociationsResult |
describeExtensionPackAssociations(DescribeExtensionPackAssociationsRequest describeExtensionPackAssociationsRequest)
Returns a paginated list of extension pack associations for the specified migration project.
|
DescribeFleetAdvisorCollectorsResult |
describeFleetAdvisorCollectors(DescribeFleetAdvisorCollectorsRequest describeFleetAdvisorCollectorsRequest)
Returns a list of the Fleet Advisor collectors in your account.
|
DescribeFleetAdvisorDatabasesResult |
describeFleetAdvisorDatabases(DescribeFleetAdvisorDatabasesRequest describeFleetAdvisorDatabasesRequest)
Returns a list of Fleet Advisor databases in your account.
|
DescribeFleetAdvisorLsaAnalysisResult |
describeFleetAdvisorLsaAnalysis(DescribeFleetAdvisorLsaAnalysisRequest describeFleetAdvisorLsaAnalysisRequest)
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
|
DescribeFleetAdvisorSchemaObjectSummaryResult |
describeFleetAdvisorSchemaObjectSummary(DescribeFleetAdvisorSchemaObjectSummaryRequest describeFleetAdvisorSchemaObjectSummaryRequest)
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
|
DescribeFleetAdvisorSchemasResult |
describeFleetAdvisorSchemas(DescribeFleetAdvisorSchemasRequest describeFleetAdvisorSchemasRequest)
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
|
DescribeInstanceProfilesResult |
describeInstanceProfiles(DescribeInstanceProfilesRequest describeInstanceProfilesRequest)
Returns a paginated list of instance profiles for your account in the current region.
|
DescribeMetadataModelAssessmentsResult |
describeMetadataModelAssessments(DescribeMetadataModelAssessmentsRequest describeMetadataModelAssessmentsRequest)
Returns a paginated list of metadata model assessments for your account in the current region.
|
DescribeMetadataModelConversionsResult |
describeMetadataModelConversions(DescribeMetadataModelConversionsRequest describeMetadataModelConversionsRequest)
Returns a paginated list of metadata model conversions for a migration project.
|
DescribeMetadataModelExportsAsScriptResult |
describeMetadataModelExportsAsScript(DescribeMetadataModelExportsAsScriptRequest describeMetadataModelExportsAsScriptRequest)
Returns a paginated list of metadata model exports.
|
DescribeMetadataModelExportsToTargetResult |
describeMetadataModelExportsToTarget(DescribeMetadataModelExportsToTargetRequest describeMetadataModelExportsToTargetRequest)
Returns a paginated list of metadata model exports.
|
DescribeMetadataModelImportsResult |
describeMetadataModelImports(DescribeMetadataModelImportsRequest describeMetadataModelImportsRequest)
Returns a paginated list of metadata model imports.
|
DescribeMigrationProjectsResult |
describeMigrationProjects(DescribeMigrationProjectsRequest describeMigrationProjectsRequest)
Returns a paginated list of migration projects for your account in the current region.
|
DescribeOrderableReplicationInstancesResult |
describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)
Returns information about the replication instance types that can be created in the specified region.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
For internal use only
|
DescribeRecommendationLimitationsResult |
describeRecommendationLimitations(DescribeRecommendationLimitationsRequest describeRecommendationLimitationsRequest)
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
|
DescribeRecommendationsResult |
describeRecommendations(DescribeRecommendationsRequest describeRecommendationsRequest)
Returns a paginated list of target engine recommendations for your source databases.
|
DescribeRefreshSchemasStatusResult |
describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)
Returns the status of the RefreshSchemas operation.
|
DescribeReplicationConfigsResult |
describeReplicationConfigs(DescribeReplicationConfigsRequest describeReplicationConfigsRequest)
Returns one or more existing DMS Serverless replication configurations as a list of structures.
|
DescribeReplicationInstancesResult |
describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)
Returns information about replication instances for your account in the current region.
|
DescribeReplicationInstanceTaskLogsResult |
describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest describeReplicationInstanceTaskLogsRequest)
Returns information about the task logs for the specified task.
|
DescribeReplicationsResult |
describeReplications(DescribeReplicationsRequest describeReplicationsRequest)
Provides details on replication progress by returning status information for one or more provisioned DMS
Serverless replications.
|
DescribeReplicationSubnetGroupsResult |
describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)
Returns information about the replication subnet groups.
|
DescribeReplicationTableStatisticsResult |
describeReplicationTableStatistics(DescribeReplicationTableStatisticsRequest describeReplicationTableStatisticsRequest)
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless
replication configuration.
|
DescribeReplicationTaskAssessmentResultsResult |
describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest describeReplicationTaskAssessmentResultsRequest)
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services
account.
|
DescribeReplicationTaskAssessmentRunsResult |
describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest describeReplicationTaskAssessmentRunsRequest)
Returns a paginated list of premigration assessment runs based on filter settings.
|
DescribeReplicationTaskIndividualAssessmentsResult |
describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest describeReplicationTaskIndividualAssessmentsRequest)
Returns a paginated list of individual assessments based on filter settings.
|
DescribeReplicationTasksResult |
describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)
Returns information about replication tasks for your account in the current region.
|
DescribeSchemasResult |
describeSchemas(DescribeSchemasRequest describeSchemasRequest)
Returns information about the schema for the specified endpoint.
|
DescribeTableStatisticsResult |
describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and
rows deleted.
|
ExportMetadataModelAssessmentResult |
exportMetadataModelAssessment(ExportMetadataModelAssessmentRequest exportMetadataModelAssessmentRequest)
Saves a copy of a database migration assessment report to your Amazon S3 bucket.
|
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 importCertificateRequest)
Uploads the specified certificate.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and
migration task.
|
ModifyConversionConfigurationResult |
modifyConversionConfiguration(ModifyConversionConfigurationRequest modifyConversionConfigurationRequest)
Modifies the specified schema conversion configuration using the provided parameters.
|
ModifyDataProviderResult |
modifyDataProvider(ModifyDataProviderRequest modifyDataProviderRequest)
Modifies the specified data provider using the provided settings.
|
ModifyEndpointResult |
modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)
Modifies the specified endpoint.
|
ModifyEventSubscriptionResult |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing DMS event notification subscription.
|
ModifyInstanceProfileResult |
modifyInstanceProfile(ModifyInstanceProfileRequest modifyInstanceProfileRequest)
Modifies the specified instance profile using the provided parameters.
|
ModifyMigrationProjectResult |
modifyMigrationProject(ModifyMigrationProjectRequest modifyMigrationProjectRequest)
Modifies the specified migration project using the provided parameters.
|
ModifyReplicationConfigResult |
modifyReplicationConfig(ModifyReplicationConfigRequest modifyReplicationConfigRequest)
Modifies an existing DMS Serverless replication configuration that you can use to start a replication.
|
ModifyReplicationInstanceResult |
modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest)
Modifies the replication instance to apply new settings.
|
ModifyReplicationSubnetGroupResult |
modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)
Modifies the settings for the specified replication subnet group.
|
ModifyReplicationTaskResult |
modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest)
Modifies the specified replication task.
|
MoveReplicationTaskResult |
moveReplicationTask(MoveReplicationTaskRequest moveReplicationTaskRequest)
Moves a replication task from its current replication instance to a different target replication instance using
the specified parameters.
|
RebootReplicationInstanceResult |
rebootReplicationInstance(RebootReplicationInstanceRequest rebootReplicationInstanceRequest)
Reboots a replication instance.
|
RefreshSchemasResult |
refreshSchemas(RefreshSchemasRequest refreshSchemasRequest)
Populates the schema for the specified endpoint.
|
ReloadReplicationTablesResult |
reloadReplicationTables(ReloadReplicationTablesRequest reloadReplicationTablesRequest)
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
|
ReloadTablesResult |
reloadTables(ReloadTablesRequest reloadTablesRequest)
Reloads the target database table with the source data.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration
task.
|
RunFleetAdvisorLsaAnalysisResult |
runFleetAdvisorLsaAnalysis(RunFleetAdvisorLsaAnalysisRequest runFleetAdvisorLsaAnalysisRequest)
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartExtensionPackAssociationResult |
startExtensionPackAssociation(StartExtensionPackAssociationRequest startExtensionPackAssociationRequest)
Applies the extension pack to your target database.
|
StartMetadataModelAssessmentResult |
startMetadataModelAssessment(StartMetadataModelAssessmentRequest startMetadataModelAssessmentRequest)
Creates a database migration assessment report by assessing the migration complexity for your source database.
|
StartMetadataModelConversionResult |
startMetadataModelConversion(StartMetadataModelConversionRequest startMetadataModelConversionRequest)
Converts your source database objects to a format compatible with the target database.
|
StartMetadataModelExportAsScriptResult |
startMetadataModelExportAsScript(StartMetadataModelExportAsScriptRequest startMetadataModelExportAsScriptRequest)
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
|
StartMetadataModelExportToTargetResult |
startMetadataModelExportToTarget(StartMetadataModelExportToTargetRequest startMetadataModelExportToTargetRequest)
Applies converted database objects to your target database.
|
StartMetadataModelImportResult |
startMetadataModelImport(StartMetadataModelImportRequest startMetadataModelImportRequest)
Loads the metadata for all the dependent database objects of the parent object.
|
StartRecommendationsResult |
startRecommendations(StartRecommendationsRequest startRecommendationsRequest)
Starts the analysis of your source database to provide recommendations of target engines.
|
StartReplicationResult |
startReplication(StartReplicationRequest startReplicationRequest)
For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the
metadata to analyze the replication workload.
|
StartReplicationTaskResult |
startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)
Starts the replication task.
|
StartReplicationTaskAssessmentResult |
startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest startReplicationTaskAssessmentRequest)
Starts the replication task assessment for unsupported data types in the source database.
|
StartReplicationTaskAssessmentRunResult |
startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest startReplicationTaskAssessmentRunRequest)
Starts a new premigration assessment run for one or more individual assessments of a migration task.
|
StopReplicationResult |
stopReplication(StopReplicationRequest stopReplicationRequest)
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications.
|
StopReplicationTaskResult |
stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)
Stops the replication task.
|
TestConnectionResult |
testConnection(TestConnectionRequest testConnectionRequest)
Tests the connection between the replication instance and the endpoint.
|
UpdateSubscriptionsToEventBridgeResult |
updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest updateSubscriptionsToEventBridgeRequest)
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon
EventBridge rules.
|
AWSDatabaseMigrationServiceWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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.
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)
AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet 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.
addTagsToResourceRequest
- Associates a set of tags with an DMS resource.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); AddTagsToResourceRequest request = new AddTagsToResourceRequest() //Required. Use the ARN of the resource you want to tag. .withResourceArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E")//Required. Use the Key/Value pair format. .withTags(new Tag().withKey("Acount").withValue("1633456")); AddTagsToResourceResult response = client.addTagsToResource(request);
ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a replication instance).
applyPendingMaintenanceActionRequest
- ResourceNotFoundException
- The resource could not be found.BatchStartRecommendationsResult batchStartRecommendations(BatchStartRecommendationsRequest batchStartRecommendationsRequest)
Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations .
The result of analysis of each source database is reported individually in the response. Because the batch
request can result in a combination of successful and unsuccessful actions, you should check for batch errors
even when the call returns an HTTP status code of 200
.
batchStartRecommendationsRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.CancelReplicationTaskAssessmentRunResult cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest cancelReplicationTaskAssessmentRunRequest)
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.
cancelReplicationTaskAssessmentRunRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.CreateDataProviderResult createDataProvider(CreateDataProviderRequest createDataProviderRequest)
Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
createDataProviderRequest
- ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)
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.
createEndpointRequest
- KMSKeyNotAccessibleException
- 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
- DMS was denied access to the endpoint. Check that the role is correctly configured.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); CreateEndpointRequest request = new CreateEndpointRequest().withEndpointIdentifier("test-endpoint-1").withEndpointType("source") .withEngineName("mysql").withUsername("username").withPassword("pasword").withServerName("mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com") .withPort(3306).withDatabaseName("testdb").withExtraConnectionAttributes("") .withKmsKeyId("arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd") .withTags(new Tag().withKey("Acount").withValue("143327655")).withCertificateArn("").withSslMode("require"); CreateEndpointResult response = client.createEndpoint(request);
CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
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.
createEventSubscriptionRequest
- ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.ResourceNotFoundException
- The resource could not be found.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.KMSAccessDeniedException
- The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.KMSDisabledException
- The specified KMS key isn't enabled.KMSInvalidStateException
- The state of the specified KMS resource isn't valid for this request.KMSNotFoundException
- The specified KMS entity or resource can't be found.KMSThrottlingException
- This request triggered KMS request throttling.CreateFleetAdvisorCollectorResult createFleetAdvisorCollector(CreateFleetAdvisorCollectorRequest createFleetAdvisorCollectorRequest)
Creates a Fleet Advisor collector using the specified parameters.
createFleetAdvisorCollectorRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates the instance profile using the specified parameters.
createInstanceProfileRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.CreateMigrationProjectResult createMigrationProject(CreateMigrationProjectRequest createMigrationProjectRequest)
Creates the migration project using the specified parameters.
You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.
createMigrationProjectRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.ResourceNotFoundException
- The resource could not be found.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.CreateReplicationConfigResult createReplicationConfig(CreateReplicationConfigRequest createReplicationConfigRequest)
Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.
createReplicationConfigRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.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 isn't valid.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)
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.
If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.
createReplicationInstanceRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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 isn't valid.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); CreateReplicationInstanceRequest request = new CreateReplicationInstanceRequest().withReplicationInstanceIdentifier("").withAllocatedStorage(123) .withReplicationInstanceClass("").withVpcSecurityGroupIds(new ArrayList()).withAvailabilityZone("").withReplicationSubnetGroupIdentifier("") .withPreferredMaintenanceWindow("").withMultiAZ(true).withEngineVersion("").withAutoMinorVersionUpgrade(true) .withTags(new Tag().withKey("string").withValue("string")).withKmsKeyId("").withPubliclyAccessible(true); CreateReplicationInstanceResult response = client.createReplicationInstance(request);
CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)
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.
If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action returns the following error message: The Replication Subnet Group already exists. In this case, delete the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, then choose your subnet group. Next, choose Delete from Actions.
createReplicationSubnetGroupRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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 isn't valid.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); CreateReplicationSubnetGroupRequest request = new CreateReplicationSubnetGroupRequest() .withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366").withReplicationSubnetGroupDescription("US West subnet group") .withSubnetIds("subnet-e145356n", "subnet-58f79200").withTags(new Tag().withKey("Acount").withValue("145235")); CreateReplicationSubnetGroupResult response = client.createReplicationSubnetGroup(request);
CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)
Creates a replication task using the specified parameters.
createReplicationTaskRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); CreateReplicationTaskRequest request = new CreateReplicationTaskRequest().withReplicationTaskIdentifier("task1") .withSourceEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE") .withTargetEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E") .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withMigrationType("full-load") .withTableMappings("file://mappingfile.json").withReplicationTaskSettings("").withCdcStartTime(new Date("2016-12-14T18:25:43Z")) .withTags(new Tag().withKey("Acount").withValue("24352226")); CreateReplicationTaskResult response = client.createReplicationTask(request);
DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
deleteCertificateRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DeleteCertificateRequest request = new DeleteCertificateRequest().withCertificateArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ"); DeleteCertificateResult response = client.deleteCertificate(request);
DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
Deletes the connection between a replication instance and an endpoint.
deleteConnectionRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteDataProviderResult deleteDataProvider(DeleteDataProviderRequest deleteDataProviderRequest)
Deletes the specified data provider.
All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.
deleteDataProviderRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpointRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DeleteEndpointRequest request = new DeleteEndpointRequest().withEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM"); DeleteEndpointResult response = client.deleteEndpoint(request);
DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an DMS event subscription.
deleteEventSubscriptionRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteFleetAdvisorCollectorResult deleteFleetAdvisorCollector(DeleteFleetAdvisorCollectorRequest deleteFleetAdvisorCollectorRequest)
Deletes the specified Fleet Advisor collector.
deleteFleetAdvisorCollectorRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.CollectorNotFoundException
- The specified collector doesn't exist.DeleteFleetAdvisorDatabasesResult deleteFleetAdvisorDatabases(DeleteFleetAdvisorDatabasesRequest deleteFleetAdvisorDatabasesRequest)
Deletes the specified Fleet Advisor collector databases.
deleteFleetAdvisorDatabasesRequest
- ResourceNotFoundException
- The resource could not be found.InvalidOperationException
- The action or operation requested isn't valid.DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes the specified instance profile.
All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.
deleteInstanceProfileRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteMigrationProjectResult deleteMigrationProject(DeleteMigrationProjectRequest deleteMigrationProjectRequest)
Deletes the specified migration project.
The migration project must be closed before you can delete it.
deleteMigrationProjectRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteReplicationConfigResult deleteReplicationConfig(DeleteReplicationConfigRequest deleteReplicationConfigRequest)
Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
deleteReplicationConfigRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
deleteReplicationInstanceRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DeleteReplicationInstanceRequest request = new DeleteReplicationInstanceRequest() .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"); DeleteReplicationInstanceResult response = client.deleteReplicationInstance(request);
DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)
Deletes a subnet group.
deleteReplicationSubnetGroupRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DeleteReplicationSubnetGroupRequest request = new DeleteReplicationSubnetGroupRequest() .withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366"); DeleteReplicationSubnetGroupResult response = client.deleteReplicationSubnetGroup(request);
DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)
Deletes the specified replication task.
deleteReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DeleteReplicationTaskRequest request = new DeleteReplicationTaskRequest() .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"); DeleteReplicationTaskResult response = client.deleteReplicationTask(request);
DeleteReplicationTaskAssessmentRunResult deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest deleteReplicationTaskAssessmentRunRequest)
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.
deleteReplicationTaskAssessmentRunRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
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.
describeAccountAttributesRequest
- AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest(); DescribeAccountAttributesResult response = client.describeAccountAttributes(request);
DescribeApplicableIndividualAssessmentsResult describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest describeApplicableIndividualAssessmentsRequest)
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.
describeApplicableIndividualAssessmentsRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Provides a description of the certificate.
describeCertificatesRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeCertificatesRequest request = new DescribeCertificatesRequest().withFilters(new Filter().withName("string").withValues("string", "string")) .withMaxRecords(123).withMarker(""); DescribeCertificatesResult response = client.describeCertificates(request);
DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
describeConnectionsRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeConnectionsRequest request = new DescribeConnectionsRequest().withFilters(new Filter().withName("string").withValues("string", "string")) .withMaxRecords(123).withMarker(""); DescribeConnectionsResult response = client.describeConnections(request);
DescribeConversionConfigurationResult describeConversionConfiguration(DescribeConversionConfigurationRequest describeConversionConfigurationRequest)
Returns configuration parameters for a schema conversion project.
describeConversionConfigurationRequest
- ResourceNotFoundException
- The resource could not be found.DescribeDataProvidersResult describeDataProviders(DescribeDataProvidersRequest describeDataProvidersRequest)
Returns a paginated list of data providers for your account in the current region.
describeDataProvidersRequest
- ResourceNotFoundException
- The resource could not be found.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.DescribeEndpointSettingsResult describeEndpointSettings(DescribeEndpointSettingsRequest describeEndpointSettingsRequest)
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
describeEndpointSettingsRequest
- DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)
Returns information about the type of endpoints available.
describeEndpointTypesRequest
- AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeEndpointTypesRequest request = new DescribeEndpointTypesRequest().withFilters(new Filter().withName("string").withValues("string", "string")) .withMaxRecords(123).withMarker(""); DescribeEndpointTypesResult response = client.describeEndpointTypes(request);
DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns information about the endpoints for your account in the current region.
describeEndpointsRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeEndpointsRequest request = new DescribeEndpointsRequest().withFilters(new Filter().withName("string").withValues("string", "string")) .withMaxRecords(123).withMarker(""); DescribeEndpointsResult response = client.describeEndpoints(request);
DescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest describeEngineVersionsRequest)
Returns information about the replication instance versions used in the project.
describeEngineVersionsRequest
- DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
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.
describeEventCategoriesRequest
- DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
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.
describeEventSubscriptionsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
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.
describeEventsRequest
- DescribeExtensionPackAssociationsResult describeExtensionPackAssociations(DescribeExtensionPackAssociationsRequest describeExtensionPackAssociationsRequest)
Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
describeExtensionPackAssociationsRequest
- DescribeFleetAdvisorCollectorsResult describeFleetAdvisorCollectors(DescribeFleetAdvisorCollectorsRequest describeFleetAdvisorCollectorsRequest)
Returns a list of the Fleet Advisor collectors in your account.
describeFleetAdvisorCollectorsRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeFleetAdvisorDatabasesResult describeFleetAdvisorDatabases(DescribeFleetAdvisorDatabasesRequest describeFleetAdvisorDatabasesRequest)
Returns a list of Fleet Advisor databases in your account.
describeFleetAdvisorDatabasesRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeFleetAdvisorLsaAnalysisResult describeFleetAdvisorLsaAnalysis(DescribeFleetAdvisorLsaAnalysisRequest describeFleetAdvisorLsaAnalysisRequest)
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
describeFleetAdvisorLsaAnalysisRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeFleetAdvisorSchemaObjectSummaryResult describeFleetAdvisorSchemaObjectSummary(DescribeFleetAdvisorSchemaObjectSummaryRequest describeFleetAdvisorSchemaObjectSummaryRequest)
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
describeFleetAdvisorSchemaObjectSummaryRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeFleetAdvisorSchemasResult describeFleetAdvisorSchemas(DescribeFleetAdvisorSchemasRequest describeFleetAdvisorSchemasRequest)
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
describeFleetAdvisorSchemasRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeInstanceProfilesResult describeInstanceProfiles(DescribeInstanceProfilesRequest describeInstanceProfilesRequest)
Returns a paginated list of instance profiles for your account in the current region.
describeInstanceProfilesRequest
- ResourceNotFoundException
- The resource could not be found.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.DescribeMetadataModelAssessmentsResult describeMetadataModelAssessments(DescribeMetadataModelAssessmentsRequest describeMetadataModelAssessmentsRequest)
Returns a paginated list of metadata model assessments for your account in the current region.
describeMetadataModelAssessmentsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeMetadataModelConversionsResult describeMetadataModelConversions(DescribeMetadataModelConversionsRequest describeMetadataModelConversionsRequest)
Returns a paginated list of metadata model conversions for a migration project.
describeMetadataModelConversionsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeMetadataModelExportsAsScriptResult describeMetadataModelExportsAsScript(DescribeMetadataModelExportsAsScriptRequest describeMetadataModelExportsAsScriptRequest)
Returns a paginated list of metadata model exports.
describeMetadataModelExportsAsScriptRequest
- ResourceNotFoundException
- The resource could not be found.DescribeMetadataModelExportsToTargetResult describeMetadataModelExportsToTarget(DescribeMetadataModelExportsToTargetRequest describeMetadataModelExportsToTargetRequest)
Returns a paginated list of metadata model exports.
describeMetadataModelExportsToTargetRequest
- ResourceNotFoundException
- The resource could not be found.DescribeMetadataModelImportsResult describeMetadataModelImports(DescribeMetadataModelImportsRequest describeMetadataModelImportsRequest)
Returns a paginated list of metadata model imports.
describeMetadataModelImportsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeMigrationProjectsResult describeMigrationProjects(DescribeMigrationProjectsRequest describeMigrationProjectsRequest)
Returns a paginated list of migration projects for your account in the current region.
describeMigrationProjectsRequest
- ResourceNotFoundException
- The resource could not be found.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstancesRequest
- AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeOrderableReplicationInstancesRequest request = new DescribeOrderableReplicationInstancesRequest().withMaxRecords(123).withMarker(""); DescribeOrderableReplicationInstancesResult response = client.describeOrderableReplicationInstances(request);
DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
For internal use only
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeRecommendationLimitationsResult describeRecommendationLimitations(DescribeRecommendationLimitationsRequest describeRecommendationLimitationsRequest)
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
describeRecommendationLimitationsRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.DescribeRecommendationsResult describeRecommendations(DescribeRecommendationsRequest describeRecommendationsRequest)
Returns a paginated list of target engine recommendations for your source databases.
describeRecommendationsRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatusRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeRefreshSchemasStatusRequest request = new DescribeRefreshSchemasStatusRequest().withEndpointArn(""); DescribeRefreshSchemasStatusResult response = client.describeRefreshSchemasStatus(request);
DescribeReplicationConfigsResult describeReplicationConfigs(DescribeReplicationConfigsRequest describeReplicationConfigsRequest)
Returns one or more existing DMS Serverless replication configurations as a list of structures.
describeReplicationConfigsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest describeReplicationInstanceTaskLogsRequest)
Returns information about the task logs for the specified task.
describeReplicationInstanceTaskLogsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)
Returns information about replication instances for your account in the current region.
describeReplicationInstancesRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeReplicationInstancesRequest request = new DescribeReplicationInstancesRequest() .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker(""); DescribeReplicationInstancesResult response = client.describeReplicationInstances(request);
DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)
Returns information about the replication subnet groups.
describeReplicationSubnetGroupsRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeReplicationSubnetGroupsRequest request = new DescribeReplicationSubnetGroupsRequest() .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker(""); DescribeReplicationSubnetGroupsResult response = client.describeReplicationSubnetGroups(request);
DescribeReplicationTableStatisticsResult describeReplicationTableStatistics(DescribeReplicationTableStatisticsRequest describeReplicationTableStatisticsRequest)
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.
describeReplicationTableStatisticsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest describeReplicationTaskAssessmentResultsRequest)
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.
describeReplicationTaskAssessmentResultsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationTaskAssessmentRunsResult describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest describeReplicationTaskAssessmentRunsRequest)
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.
describeReplicationTaskAssessmentRunsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationTaskIndividualAssessmentsResult describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest describeReplicationTaskIndividualAssessmentsRequest)
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.
describeReplicationTaskIndividualAssessmentsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)
Returns information about replication tasks for your account in the current region.
describeReplicationTasksRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeReplicationTasksRequest request = new DescribeReplicationTasksRequest() .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker(""); DescribeReplicationTasksResult response = client.describeReplicationTasks(request);
DescribeReplicationsResult describeReplications(DescribeReplicationsRequest describeReplicationsRequest)
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
describeReplicationsRequest
- ResourceNotFoundException
- The resource could not be found.DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest)
Returns information about the schema for the specified endpoint.
describeSchemasRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeSchemasRequest request = new DescribeSchemasRequest().withEndpointArn("").withMaxRecords(123).withMarker(""); DescribeSchemasResult response = client.describeSchemas(request);
DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)
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.
describeTableStatisticsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); DescribeTableStatisticsRequest request = new DescribeTableStatisticsRequest().withReplicationTaskArn("").withMaxRecords(123).withMarker(""); DescribeTableStatisticsResult response = client.describeTableStatistics(request);
ExportMetadataModelAssessmentResult exportMetadataModelAssessment(ExportMetadataModelAssessmentRequest exportMetadataModelAssessmentRequest)
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.
exportMetadataModelAssessmentRequest
- ResourceNotFoundException
- The resource could not be found.ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest)
Uploads the specified certificate.
importCertificateRequest
- ResourceAlreadyExistsException
- The resource you are attempting to create already exists.InvalidCertificateException
- The certificate was not valid.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); ImportCertificateRequest request = new ImportCertificateRequest().withCertificateIdentifier("").withCertificatePem(""); ImportCertificateResult response = client.importCertificate(request);
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and
migration task. For more information, see Tag
data type
description.
listTagsForResourceRequest
- ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); ListTagsForResourceRequest request = new ListTagsForResourceRequest().withResourceArn(""); ListTagsForResourceResult response = client.listTagsForResource(request);
ModifyConversionConfigurationResult modifyConversionConfiguration(ModifyConversionConfigurationRequest modifyConversionConfigurationRequest)
Modifies the specified schema conversion configuration using the provided parameters.
modifyConversionConfigurationRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ModifyDataProviderResult modifyDataProvider(ModifyDataProviderRequest modifyDataProviderRequest)
Modifies the specified data provider using the provided settings.
You must remove the data provider from all migration projects before you can modify it.
modifyDataProviderRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)
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.
modifyEndpointRequest
- 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
- DMS cannot access the KMS key.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); ModifyEndpointRequest request = new ModifyEndpointRequest().withEndpointArn("").withEndpointIdentifier("").withEndpointType("source") .withEngineName("").withUsername("").withPassword("").withServerName("").withPort(123).withDatabaseName("").withExtraConnectionAttributes("") .withCertificateArn("").withSslMode("require"); ModifyEndpointResult response = client.modifyEndpoint(request);
ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing DMS event notification subscription.
modifyEventSubscriptionRequest
- 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.KMSAccessDeniedException
- The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.KMSDisabledException
- The specified KMS key isn't enabled.KMSInvalidStateException
- The state of the specified KMS resource isn't valid for this request.KMSNotFoundException
- The specified KMS entity or resource can't be found.KMSThrottlingException
- This request triggered KMS request throttling.ModifyInstanceProfileResult modifyInstanceProfile(ModifyInstanceProfileRequest modifyInstanceProfileRequest)
Modifies the specified instance profile using the provided parameters.
All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
modifyInstanceProfileRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.ModifyMigrationProjectResult modifyMigrationProject(ModifyMigrationProjectRequest modifyMigrationProjectRequest)
Modifies the specified migration project using the provided parameters.
The migration project must be closed before you can modify it.
modifyMigrationProjectRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.ModifyReplicationConfigResult modifyReplicationConfig(ModifyReplicationConfigRequest modifyReplicationConfigRequest)
Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it.
Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.
modifyReplicationConfigRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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.InvalidSubnetException
- The subnet provided isn't valid.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest)
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
modifyReplicationInstanceRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); ModifyReplicationInstanceRequest request = new ModifyReplicationInstanceRequest() .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withAllocatedStorage(123) .withApplyImmediately(true).withReplicationInstanceClass("dms.t2.micro").withVpcSecurityGroupIds(new ArrayList()) .withPreferredMaintenanceWindow("sun:06:00-sun:14:00").withMultiAZ(true).withEngineVersion("1.5.0").withAllowMajorVersionUpgrade(true) .withAutoMinorVersionUpgrade(true).withReplicationInstanceIdentifier("test-rep-1"); ModifyReplicationInstanceResult response = client.modifyReplicationInstance(request);
ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroupRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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 isn't valid.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); ModifyReplicationSubnetGroupRequest request = new ModifyReplicationSubnetGroupRequest().withReplicationSubnetGroupIdentifier("") .withReplicationSubnetGroupDescription("").withSubnetIds(new ArrayList()); ModifyReplicationSubnetGroupResult response = client.modifyReplicationSubnetGroup(request);
ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest)
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.
modifyReplicationTaskRequest
- 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
- DMS cannot access the KMS key.MoveReplicationTaskResult moveReplicationTask(MoveReplicationTaskRequest moveReplicationTaskRequest)
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.
moveReplicationTaskRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest rebootReplicationInstanceRequest)
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
rebootReplicationInstanceRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.RefreshSchemasResult refreshSchemas(RefreshSchemasRequest refreshSchemasRequest)
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
refreshSchemasRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); RefreshSchemasRequest request = new RefreshSchemasRequest().withEndpointArn("").withReplicationInstanceArn(""); RefreshSchemasResult response = client.refreshSchemas(request);
ReloadReplicationTablesResult reloadReplicationTables(ReloadReplicationTablesRequest reloadReplicationTablesRequest)
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
You can only use this operation with a task in the RUNNING state, otherwise the service will throw an
InvalidResourceStateFault
exception.
reloadReplicationTablesRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ReloadTablesResult reloadTables(ReloadTablesRequest reloadTablesRequest)
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.
reloadTablesRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration
task. For more information, see
Tag
data type description.
removeTagsFromResourceRequest
- Removes one or more tags from an DMS resource.ResourceNotFoundException
- The resource could not be found.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceArn( "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E").withTagKeys(new ArrayList()); RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);
RunFleetAdvisorLsaAnalysisResult runFleetAdvisorLsaAnalysis(RunFleetAdvisorLsaAnalysisRequest runFleetAdvisorLsaAnalysisRequest)
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
runFleetAdvisorLsaAnalysisRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.StartExtensionPackAssociationResult startExtensionPackAssociation(StartExtensionPackAssociationRequest startExtensionPackAssociationRequest)
Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
startExtensionPackAssociationRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartMetadataModelAssessmentResult startMetadataModelAssessment(StartMetadataModelAssessmentRequest startMetadataModelAssessmentRequest)
Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.
startMetadataModelAssessmentRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartMetadataModelConversionResult startMetadataModelConversion(StartMetadataModelConversionRequest startMetadataModelConversionRequest)
Converts your source database objects to a format compatible with the target database.
startMetadataModelConversionRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartMetadataModelExportAsScriptResult startMetadataModelExportAsScript(StartMetadataModelExportAsScriptRequest startMetadataModelExportAsScriptRequest)
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
startMetadataModelExportAsScriptRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartMetadataModelExportToTargetResult startMetadataModelExportToTarget(StartMetadataModelExportToTargetRequest startMetadataModelExportToTargetRequest)
Applies converted database objects to your target database.
startMetadataModelExportToTargetRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartMetadataModelImportResult startMetadataModelImport(StartMetadataModelImportRequest startMetadataModelImportRequest)
Loads the metadata for all the dependent database objects of the parent object.
This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
startMetadataModelImportRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.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
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.StartRecommendationsResult startRecommendations(StartRecommendationsRequest startRecommendationsRequest)
Starts the analysis of your source database to provide recommendations of target engines.
You can create recommendations for multiple source databases using BatchStartRecommendations.
startRecommendationsRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.StartReplicationResult startReplication(StartReplicationRequest startReplicationRequest)
For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.
startReplicationRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)
Starts the replication task.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
startReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); StartReplicationTaskRequest request = new StartReplicationTaskRequest() .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withStartReplicationTaskType("start-replication") .withCdcStartTime(new Date("2016-12-14T13:33:20Z")); StartReplicationTaskResult response = client.startReplicationTask(request);
StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest startReplicationTaskAssessmentRequest)
Starts the replication task assessment for unsupported data types in the source database.
You can only use this operation for a task if the following conditions are true:
The task must be in the stopped
state.
The task must have successful connections to the source and target.
If either of these conditions are not met, an InvalidResourceStateFault
error will result.
For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
startReplicationTaskAssessmentRequest
- InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.ResourceNotFoundException
- The resource could not be found.StartReplicationTaskAssessmentRunResult startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest startReplicationTaskAssessmentRunRequest)
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.
startReplicationTaskAssessmentRunRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSAccessDeniedException
- The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.KMSDisabledException
- The specified KMS key isn't enabled.KMSException
- An Key Management Service (KMS) error is preventing access to KMS.KMSInvalidStateException
- The state of the specified KMS resource isn't valid for this request.KMSNotFoundException
- The specified KMS entity or resource can't be found.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.S3AccessDeniedException
- Insufficient privileges are preventing access to an Amazon S3 object.S3ResourceNotFoundException
- A specified Amazon S3 bucket, bucket folder, or other object can't be found.ResourceAlreadyExistsException
- The resource you are attempting to create already exists.StopReplicationResult stopReplication(StopReplicationRequest stopReplicationRequest)
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
stopReplicationRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)
Stops the replication task.
stopReplicationTaskRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); StopReplicationTaskRequest request = new StopReplicationTaskRequest() .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"); StopReplicationTaskResult response = client.stopReplicationTask(request);
TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)
Tests the connection between the replication instance and the endpoint.
testConnectionRequest
- ResourceNotFoundException
- The resource could not be found.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.KMSKeyNotAccessibleException
- DMS cannot access the KMS key.ResourceQuotaExceededException
- The quota for this resource quota has been exceeded.AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build(); TestConnectionRequest request = new TestConnectionRequest().withReplicationInstanceArn( "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withEndpointArn( "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM"); TestConnectionResult response = client.testConnection(request);
UpdateSubscriptionsToEventBridgeResult updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest updateSubscriptionsToEventBridgeRequest)
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon
EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance
versions are 3.4.5 or higher. If any replication instances are from versions earlier than 3.4.5, the operation
raises an error and tells you to upgrade these instances to version 3.4.5 or higher. To enable migration
regardless of version, set the Force
option to true. However, if you don't upgrade instances earlier
than version 3.4.5, some types of events might not be available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide.
updateSubscriptionsToEventBridgeRequest
- AccessDeniedException
- DMS was denied access to the endpoint. Check that the role is correctly configured.InvalidResourceStateException
- The resource is in a state that prevents it from being used for database migration.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.AWSDatabaseMigrationServiceWaiters waiters()