@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSDatabaseMigrationService extends Object implements AWSDatabaseMigrationService
AWSDatabaseMigrationService
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration
task.
|
ApplyPendingMaintenanceActionResult |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a replication instance).
|
BatchStartRecommendationsResult |
batchStartRecommendations(BatchStartRecommendationsRequest request)
Starts the analysis of up to 20 source databases to recommend target engines for each source database.
|
CancelReplicationTaskAssessmentRunResult |
cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest request)
Cancels a single premigration assessment run.
|
CreateDataProviderResult |
createDataProvider(CreateDataProviderRequest request)
Creates a data provider using the provided settings.
|
CreateEndpointResult |
createEndpoint(CreateEndpointRequest request)
Creates an endpoint using the provided settings.
|
CreateEventSubscriptionResult |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an DMS event notification subscription.
|
CreateFleetAdvisorCollectorResult |
createFleetAdvisorCollector(CreateFleetAdvisorCollectorRequest request)
Creates a Fleet Advisor collector using the specified parameters.
|
CreateInstanceProfileResult |
createInstanceProfile(CreateInstanceProfileRequest request)
Creates the instance profile using the specified parameters.
|
CreateMigrationProjectResult |
createMigrationProject(CreateMigrationProjectRequest request)
Creates the migration project using the specified parameters.
|
CreateReplicationConfigResult |
createReplicationConfig(CreateReplicationConfigRequest request)
Creates a configuration that you can later provide to configure and start an DMS Serverless replication.
|
CreateReplicationInstanceResult |
createReplicationInstance(CreateReplicationInstanceRequest request)
Creates the replication instance using the specified parameters.
|
CreateReplicationSubnetGroupResult |
createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
Creates a replication subnet group given a list of the subnet IDs in a VPC.
|
CreateReplicationTaskResult |
createReplicationTask(CreateReplicationTaskRequest request)
Creates a replication task using the specified parameters.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes the specified certificate.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest request)
Deletes the connection between a replication instance and an endpoint.
|
DeleteDataProviderResult |
deleteDataProvider(DeleteDataProviderRequest request)
Deletes the specified data provider.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes the specified endpoint.
|
DeleteEventSubscriptionResult |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an DMS event subscription.
|
DeleteFleetAdvisorCollectorResult |
deleteFleetAdvisorCollector(DeleteFleetAdvisorCollectorRequest request)
Deletes the specified Fleet Advisor collector.
|
DeleteFleetAdvisorDatabasesResult |
deleteFleetAdvisorDatabases(DeleteFleetAdvisorDatabasesRequest request)
Deletes the specified Fleet Advisor collector databases.
|
DeleteInstanceProfileResult |
deleteInstanceProfile(DeleteInstanceProfileRequest request)
Deletes the specified instance profile.
|
DeleteMigrationProjectResult |
deleteMigrationProject(DeleteMigrationProjectRequest request)
Deletes the specified migration project.
|
DeleteReplicationConfigResult |
deleteReplicationConfig(DeleteReplicationConfigRequest request)
Deletes an DMS Serverless replication configuration.
|
DeleteReplicationInstanceResult |
deleteReplicationInstance(DeleteReplicationInstanceRequest request)
Deletes the specified replication instance.
|
DeleteReplicationSubnetGroupResult |
deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
Deletes a subnet group.
|
DeleteReplicationTaskResult |
deleteReplicationTask(DeleteReplicationTaskRequest request)
Deletes the specified replication task.
|
DeleteReplicationTaskAssessmentRunResult |
deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest request)
Deletes the record of a single premigration assessment run.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the DMS attributes for a customer account.
|
DescribeApplicableIndividualAssessmentsResult |
describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest request)
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one
or more parameters.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest request)
Provides a description of the certificate.
|
DescribeConnectionsResult |
describeConnections(DescribeConnectionsRequest request)
Describes the status of the connections that have been made between the replication instance and an endpoint.
|
DescribeConversionConfigurationResult |
describeConversionConfiguration(DescribeConversionConfigurationRequest request)
Returns configuration parameters for a schema conversion project.
|
DescribeDataProvidersResult |
describeDataProviders(DescribeDataProvidersRequest request)
Returns a paginated list of data providers for your account in the current region.
|
DescribeEndpointsResult |
describeEndpoints(DescribeEndpointsRequest request)
Returns information about the endpoints for your account in the current region.
|
DescribeEndpointSettingsResult |
describeEndpointSettings(DescribeEndpointSettingsRequest request)
Returns information about the possible endpoint settings available when you create an endpoint for a specific
database engine.
|
DescribeEndpointTypesResult |
describeEndpointTypes(DescribeEndpointTypesRequest request)
Returns information about the type of endpoints available.
|
DescribeEngineVersionsResult |
describeEngineVersions(DescribeEngineVersionsRequest request)
Returns information about the replication instance versions used in the project.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest request)
Lists categories for all event source types, or, if specified, for a specified source type.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Lists events for a given source identifier and source type.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists all the event subscriptions for a customer account.
|
DescribeExtensionPackAssociationsResult |
describeExtensionPackAssociations(DescribeExtensionPackAssociationsRequest request)
Returns a paginated list of extension pack associations for the specified migration project.
|
DescribeFleetAdvisorCollectorsResult |
describeFleetAdvisorCollectors(DescribeFleetAdvisorCollectorsRequest request)
Returns a list of the Fleet Advisor collectors in your account.
|
DescribeFleetAdvisorDatabasesResult |
describeFleetAdvisorDatabases(DescribeFleetAdvisorDatabasesRequest request)
Returns a list of Fleet Advisor databases in your account.
|
DescribeFleetAdvisorLsaAnalysisResult |
describeFleetAdvisorLsaAnalysis(DescribeFleetAdvisorLsaAnalysisRequest request)
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
|
DescribeFleetAdvisorSchemaObjectSummaryResult |
describeFleetAdvisorSchemaObjectSummary(DescribeFleetAdvisorSchemaObjectSummaryRequest request)
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
|
DescribeFleetAdvisorSchemasResult |
describeFleetAdvisorSchemas(DescribeFleetAdvisorSchemasRequest request)
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
|
DescribeInstanceProfilesResult |
describeInstanceProfiles(DescribeInstanceProfilesRequest request)
Returns a paginated list of instance profiles for your account in the current region.
|
DescribeMetadataModelAssessmentsResult |
describeMetadataModelAssessments(DescribeMetadataModelAssessmentsRequest request)
Returns a paginated list of metadata model assessments for your account in the current region.
|
DescribeMetadataModelConversionsResult |
describeMetadataModelConversions(DescribeMetadataModelConversionsRequest request)
Returns a paginated list of metadata model conversions for a migration project.
|
DescribeMetadataModelExportsAsScriptResult |
describeMetadataModelExportsAsScript(DescribeMetadataModelExportsAsScriptRequest request)
Returns a paginated list of metadata model exports.
|
DescribeMetadataModelExportsToTargetResult |
describeMetadataModelExportsToTarget(DescribeMetadataModelExportsToTargetRequest request)
Returns a paginated list of metadata model exports.
|
DescribeMetadataModelImportsResult |
describeMetadataModelImports(DescribeMetadataModelImportsRequest request)
Returns a paginated list of metadata model imports.
|
DescribeMigrationProjectsResult |
describeMigrationProjects(DescribeMigrationProjectsRequest request)
Returns a paginated list of migration projects for your account in the current region.
|
DescribeOrderableReplicationInstancesResult |
describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
Returns information about the replication instance types that can be created in the specified region.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
For internal use only
|
DescribeRecommendationLimitationsResult |
describeRecommendationLimitations(DescribeRecommendationLimitationsRequest request)
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
|
DescribeRecommendationsResult |
describeRecommendations(DescribeRecommendationsRequest request)
Returns a paginated list of target engine recommendations for your source databases.
|
DescribeRefreshSchemasStatusResult |
describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
Returns the status of the RefreshSchemas operation.
|
DescribeReplicationConfigsResult |
describeReplicationConfigs(DescribeReplicationConfigsRequest request)
Returns one or more existing DMS Serverless replication configurations as a list of structures.
|
DescribeReplicationInstancesResult |
describeReplicationInstances(DescribeReplicationInstancesRequest request)
Returns information about replication instances for your account in the current region.
|
DescribeReplicationInstanceTaskLogsResult |
describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)
Returns information about the task logs for the specified task.
|
DescribeReplicationsResult |
describeReplications(DescribeReplicationsRequest request)
Provides details on replication progress by returning status information for one or more provisioned DMS
Serverless replications.
|
DescribeReplicationSubnetGroupsResult |
describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
Returns information about the replication subnet groups.
|
DescribeReplicationTableStatisticsResult |
describeReplicationTableStatistics(DescribeReplicationTableStatisticsRequest request)
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless
replication configuration.
|
DescribeReplicationTaskAssessmentResultsResult |
describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services
account.
|
DescribeReplicationTaskAssessmentRunsResult |
describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest request)
Returns a paginated list of premigration assessment runs based on filter settings.
|
DescribeReplicationTaskIndividualAssessmentsResult |
describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest request)
Returns a paginated list of individual assessments based on filter settings.
|
DescribeReplicationTasksResult |
describeReplicationTasks(DescribeReplicationTasksRequest request)
Returns information about replication tasks for your account in the current region.
|
DescribeSchemasResult |
describeSchemas(DescribeSchemasRequest request)
Returns information about the schema for the specified endpoint.
|
DescribeTableStatisticsResult |
describeTableStatistics(DescribeTableStatisticsRequest request)
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and
rows deleted.
|
ExportMetadataModelAssessmentResult |
exportMetadataModelAssessment(ExportMetadataModelAssessmentRequest request)
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 request)
Uploads the specified certificate.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and
migration task.
|
ModifyConversionConfigurationResult |
modifyConversionConfiguration(ModifyConversionConfigurationRequest request)
Modifies the specified schema conversion configuration using the provided parameters.
|
ModifyDataProviderResult |
modifyDataProvider(ModifyDataProviderRequest request)
Modifies the specified data provider using the provided settings.
|
ModifyEndpointResult |
modifyEndpoint(ModifyEndpointRequest request)
Modifies the specified endpoint.
|
ModifyEventSubscriptionResult |
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing DMS event notification subscription.
|
ModifyInstanceProfileResult |
modifyInstanceProfile(ModifyInstanceProfileRequest request)
Modifies the specified instance profile using the provided parameters.
|
ModifyMigrationProjectResult |
modifyMigrationProject(ModifyMigrationProjectRequest request)
Modifies the specified migration project using the provided parameters.
|
ModifyReplicationConfigResult |
modifyReplicationConfig(ModifyReplicationConfigRequest request)
Modifies an existing DMS Serverless replication configuration that you can use to start a replication.
|
ModifyReplicationInstanceResult |
modifyReplicationInstance(ModifyReplicationInstanceRequest request)
Modifies the replication instance to apply new settings.
|
ModifyReplicationSubnetGroupResult |
modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
Modifies the settings for the specified replication subnet group.
|
ModifyReplicationTaskResult |
modifyReplicationTask(ModifyReplicationTaskRequest request)
Modifies the specified replication task.
|
MoveReplicationTaskResult |
moveReplicationTask(MoveReplicationTaskRequest request)
Moves a replication task from its current replication instance to a different target replication instance using
the specified parameters.
|
RebootReplicationInstanceResult |
rebootReplicationInstance(RebootReplicationInstanceRequest request)
Reboots a replication instance.
|
RefreshSchemasResult |
refreshSchemas(RefreshSchemasRequest request)
Populates the schema for the specified endpoint.
|
ReloadReplicationTablesResult |
reloadReplicationTables(ReloadReplicationTablesRequest request)
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
|
ReloadTablesResult |
reloadTables(ReloadTablesRequest request)
Reloads the target database table with the source data.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration
task.
|
RunFleetAdvisorLsaAnalysisResult |
runFleetAdvisorLsaAnalysis(RunFleetAdvisorLsaAnalysisRequest request)
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSDatabaseMigrationService.setEndpoint(String) , sets the regional endpoint for this
client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartExtensionPackAssociationResult |
startExtensionPackAssociation(StartExtensionPackAssociationRequest request)
Applies the extension pack to your target database.
|
StartMetadataModelAssessmentResult |
startMetadataModelAssessment(StartMetadataModelAssessmentRequest request)
Creates a database migration assessment report by assessing the migration complexity for your source database.
|
StartMetadataModelConversionResult |
startMetadataModelConversion(StartMetadataModelConversionRequest request)
Converts your source database objects to a format compatible with the target database.
|
StartMetadataModelExportAsScriptResult |
startMetadataModelExportAsScript(StartMetadataModelExportAsScriptRequest request)
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
|
StartMetadataModelExportToTargetResult |
startMetadataModelExportToTarget(StartMetadataModelExportToTargetRequest request)
Applies converted database objects to your target database.
|
StartMetadataModelImportResult |
startMetadataModelImport(StartMetadataModelImportRequest request)
Loads the metadata for all the dependent database objects of the parent object.
|
StartRecommendationsResult |
startRecommendations(StartRecommendationsRequest request)
Starts the analysis of your source database to provide recommendations of target engines.
|
StartReplicationResult |
startReplication(StartReplicationRequest request)
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 request)
Starts the replication task.
|
StartReplicationTaskAssessmentResult |
startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)
Starts the replication task assessment for unsupported data types in the source database.
|
StartReplicationTaskAssessmentRunResult |
startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest request)
Starts a new premigration assessment run for one or more individual assessments of a migration task.
|
StopReplicationResult |
stopReplication(StopReplicationRequest request)
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications.
|
StopReplicationTaskResult |
stopReplicationTask(StopReplicationTaskRequest request)
Stops the replication task.
|
TestConnectionResult |
testConnection(TestConnectionRequest request)
Tests the connection between the replication instance and the endpoint.
|
UpdateSubscriptionsToEventBridgeResult |
updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest request)
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon
EventBridge rules.
|
AWSDatabaseMigrationServiceWaiters |
waiters() |
public void setEndpoint(String endpoint)
AWSDatabaseMigrationService
Callers can pass in just the endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "dms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSDatabaseMigrationService
endpoint
- The endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"dms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSDatabaseMigrationService
AWSDatabaseMigrationService.setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSDatabaseMigrationService
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSDatabaseMigrationService
Adds metadata tags to an 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.
addTagsToResource
in interface AWSDatabaseMigrationService
request
- Associates a set of tags with an DMS resource.public ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
AWSDatabaseMigrationService
Applies a pending maintenance action to a resource (for example, to a replication instance).
applyPendingMaintenanceAction
in interface AWSDatabaseMigrationService
public BatchStartRecommendationsResult batchStartRecommendations(BatchStartRecommendationsRequest request)
AWSDatabaseMigrationService
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
.
batchStartRecommendations
in interface AWSDatabaseMigrationService
public CancelReplicationTaskAssessmentRunResult cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest request)
AWSDatabaseMigrationService
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
cancelReplicationTaskAssessmentRun
in interface AWSDatabaseMigrationService
public CreateDataProviderResult createDataProvider(CreateDataProviderRequest request)
AWSDatabaseMigrationService
Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
createDataProvider
in interface AWSDatabaseMigrationService
public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
AWSDatabaseMigrationService
Creates an endpoint using the provided settings.
For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName
request parameter on the CreateEndpoint
API call. Specifying DatabaseName
when you
create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify
the database only when you specify the schema in the table-mapping rules of the DMS task.
createEndpoint
in interface AWSDatabaseMigrationService
public CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest request)
AWSDatabaseMigrationService
Creates an DMS event notification subscription.
You can specify the type of source (SourceType
) you want to be notified of, provide a list of DMS
source IDs (SourceIds
) that triggers the events, and provide a list of event categories (
EventCategories
) for events you want to be notified of. If you specify both the
SourceType
and SourceIds
, such as SourceType = replication-instance
and
SourceIdentifier = my-replinstance
, you will be notified of all the replication instance events for
the specified source. If you specify a SourceType
but don't specify a SourceIdentifier
,
you receive notice of the events for that source type for all your DMS sources. If you don't specify either
SourceType
nor SourceIdentifier
, you will be notified of events generated from all DMS
sources belonging to your customer account.
For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
createEventSubscription
in interface AWSDatabaseMigrationService
public CreateFleetAdvisorCollectorResult createFleetAdvisorCollector(CreateFleetAdvisorCollectorRequest request)
AWSDatabaseMigrationService
Creates a Fleet Advisor collector using the specified parameters.
createFleetAdvisorCollector
in interface AWSDatabaseMigrationService
public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest request)
AWSDatabaseMigrationService
Creates the instance profile using the specified parameters.
createInstanceProfile
in interface AWSDatabaseMigrationService
public CreateMigrationProjectResult createMigrationProject(CreateMigrationProjectRequest request)
AWSDatabaseMigrationService
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.
createMigrationProject
in interface AWSDatabaseMigrationService
public CreateReplicationConfigResult createReplicationConfig(CreateReplicationConfigRequest request)
AWSDatabaseMigrationService
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.
createReplicationConfig
in interface AWSDatabaseMigrationService
public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)
AWSDatabaseMigrationService
Creates the replication instance using the specified parameters.
DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
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.
createReplicationInstance
in interface AWSDatabaseMigrationService
public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Creates a replication subnet group given a list of the subnet IDs in a VPC.
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.
createReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)
AWSDatabaseMigrationService
Creates a replication task using the specified parameters.
createReplicationTask
in interface AWSDatabaseMigrationService
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSDatabaseMigrationService
Deletes the specified certificate.
deleteCertificate
in interface AWSDatabaseMigrationService
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
AWSDatabaseMigrationService
Deletes the connection between a replication instance and an endpoint.
deleteConnection
in interface AWSDatabaseMigrationService
public DeleteDataProviderResult deleteDataProvider(DeleteDataProviderRequest request)
AWSDatabaseMigrationService
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.
deleteDataProvider
in interface AWSDatabaseMigrationService
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
AWSDatabaseMigrationService
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
deleteEndpoint
in interface AWSDatabaseMigrationService
public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
AWSDatabaseMigrationService
Deletes an DMS event subscription.
deleteEventSubscription
in interface AWSDatabaseMigrationService
public DeleteFleetAdvisorCollectorResult deleteFleetAdvisorCollector(DeleteFleetAdvisorCollectorRequest request)
AWSDatabaseMigrationService
Deletes the specified Fleet Advisor collector.
deleteFleetAdvisorCollector
in interface AWSDatabaseMigrationService
public DeleteFleetAdvisorDatabasesResult deleteFleetAdvisorDatabases(DeleteFleetAdvisorDatabasesRequest request)
AWSDatabaseMigrationService
Deletes the specified Fleet Advisor collector databases.
deleteFleetAdvisorDatabases
in interface AWSDatabaseMigrationService
public DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest request)
AWSDatabaseMigrationService
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.
deleteInstanceProfile
in interface AWSDatabaseMigrationService
public DeleteMigrationProjectResult deleteMigrationProject(DeleteMigrationProjectRequest request)
AWSDatabaseMigrationService
Deletes the specified migration project.
The migration project must be closed before you can delete it.
deleteMigrationProject
in interface AWSDatabaseMigrationService
public DeleteReplicationConfigResult deleteReplicationConfig(DeleteReplicationConfigRequest request)
AWSDatabaseMigrationService
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.
deleteReplicationConfig
in interface AWSDatabaseMigrationService
public DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest request)
AWSDatabaseMigrationService
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
deleteReplicationInstance
in interface AWSDatabaseMigrationService
public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Deletes a subnet group.
deleteReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)
AWSDatabaseMigrationService
Deletes the specified replication task.
deleteReplicationTask
in interface AWSDatabaseMigrationService
public DeleteReplicationTaskAssessmentRunResult deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest request)
AWSDatabaseMigrationService
Deletes the record of a single premigration assessment run.
This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
deleteReplicationTaskAssessmentRun
in interface AWSDatabaseMigrationService
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
AWSDatabaseMigrationService
Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
describeAccountAttributes
in interface AWSDatabaseMigrationService
public DescribeApplicableIndividualAssessmentsResult describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest request)
AWSDatabaseMigrationService
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.
To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.
If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
describeApplicableIndividualAssessments
in interface AWSDatabaseMigrationService
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
AWSDatabaseMigrationService
Provides a description of the certificate.
describeCertificates
in interface AWSDatabaseMigrationService
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
AWSDatabaseMigrationService
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
describeConnections
in interface AWSDatabaseMigrationService
public DescribeConversionConfigurationResult describeConversionConfiguration(DescribeConversionConfigurationRequest request)
AWSDatabaseMigrationService
Returns configuration parameters for a schema conversion project.
describeConversionConfiguration
in interface AWSDatabaseMigrationService
public DescribeDataProvidersResult describeDataProviders(DescribeDataProvidersRequest request)
AWSDatabaseMigrationService
Returns a paginated list of data providers for your account in the current region.
describeDataProviders
in interface AWSDatabaseMigrationService
public DescribeEndpointSettingsResult describeEndpointSettings(DescribeEndpointSettingsRequest request)
AWSDatabaseMigrationService
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
describeEndpointSettings
in interface AWSDatabaseMigrationService
public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)
AWSDatabaseMigrationService
Returns information about the type of endpoints available.
describeEndpointTypes
in interface AWSDatabaseMigrationService
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
AWSDatabaseMigrationService
Returns information about the endpoints for your account in the current region.
describeEndpoints
in interface AWSDatabaseMigrationService
public DescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest request)
AWSDatabaseMigrationService
Returns information about the replication instance versions used in the project.
describeEngineVersions
in interface AWSDatabaseMigrationService
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
AWSDatabaseMigrationService
Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.
describeEventCategories
in interface AWSDatabaseMigrationService
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
AWSDatabaseMigrationService
Lists all the event subscriptions for a customer account. The description of a subscription includes
SubscriptionName
, SNSTopicARN
, CustomerID
, SourceType
,
SourceID
, CreationTime
, and Status
.
If you specify SubscriptionName
, this action lists the description for that subscription.
describeEventSubscriptions
in interface AWSDatabaseMigrationService
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AWSDatabaseMigrationService
Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
describeEvents
in interface AWSDatabaseMigrationService
public DescribeExtensionPackAssociationsResult describeExtensionPackAssociations(DescribeExtensionPackAssociationsRequest request)
AWSDatabaseMigrationService
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.
describeExtensionPackAssociations
in interface AWSDatabaseMigrationService
public DescribeFleetAdvisorCollectorsResult describeFleetAdvisorCollectors(DescribeFleetAdvisorCollectorsRequest request)
AWSDatabaseMigrationService
Returns a list of the Fleet Advisor collectors in your account.
describeFleetAdvisorCollectors
in interface AWSDatabaseMigrationService
public DescribeFleetAdvisorDatabasesResult describeFleetAdvisorDatabases(DescribeFleetAdvisorDatabasesRequest request)
AWSDatabaseMigrationService
Returns a list of Fleet Advisor databases in your account.
describeFleetAdvisorDatabases
in interface AWSDatabaseMigrationService
public DescribeFleetAdvisorLsaAnalysisResult describeFleetAdvisorLsaAnalysis(DescribeFleetAdvisorLsaAnalysisRequest request)
AWSDatabaseMigrationService
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
describeFleetAdvisorLsaAnalysis
in interface AWSDatabaseMigrationService
public DescribeFleetAdvisorSchemaObjectSummaryResult describeFleetAdvisorSchemaObjectSummary(DescribeFleetAdvisorSchemaObjectSummaryRequest request)
AWSDatabaseMigrationService
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
describeFleetAdvisorSchemaObjectSummary
in interface AWSDatabaseMigrationService
public DescribeFleetAdvisorSchemasResult describeFleetAdvisorSchemas(DescribeFleetAdvisorSchemasRequest request)
AWSDatabaseMigrationService
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
describeFleetAdvisorSchemas
in interface AWSDatabaseMigrationService
public DescribeInstanceProfilesResult describeInstanceProfiles(DescribeInstanceProfilesRequest request)
AWSDatabaseMigrationService
Returns a paginated list of instance profiles for your account in the current region.
describeInstanceProfiles
in interface AWSDatabaseMigrationService
public DescribeMetadataModelAssessmentsResult describeMetadataModelAssessments(DescribeMetadataModelAssessmentsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of metadata model assessments for your account in the current region.
describeMetadataModelAssessments
in interface AWSDatabaseMigrationService
public DescribeMetadataModelConversionsResult describeMetadataModelConversions(DescribeMetadataModelConversionsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of metadata model conversions for a migration project.
describeMetadataModelConversions
in interface AWSDatabaseMigrationService
public DescribeMetadataModelExportsAsScriptResult describeMetadataModelExportsAsScript(DescribeMetadataModelExportsAsScriptRequest request)
AWSDatabaseMigrationService
Returns a paginated list of metadata model exports.
describeMetadataModelExportsAsScript
in interface AWSDatabaseMigrationService
public DescribeMetadataModelExportsToTargetResult describeMetadataModelExportsToTarget(DescribeMetadataModelExportsToTargetRequest request)
AWSDatabaseMigrationService
Returns a paginated list of metadata model exports.
describeMetadataModelExportsToTarget
in interface AWSDatabaseMigrationService
public DescribeMetadataModelImportsResult describeMetadataModelImports(DescribeMetadataModelImportsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of metadata model imports.
describeMetadataModelImports
in interface AWSDatabaseMigrationService
public DescribeMigrationProjectsResult describeMigrationProjects(DescribeMigrationProjectsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of migration projects for your account in the current region.
describeMigrationProjects
in interface AWSDatabaseMigrationService
public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
AWSDatabaseMigrationService
Returns information about the replication instance types that can be created in the specified region.
describeOrderableReplicationInstances
in interface AWSDatabaseMigrationService
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
AWSDatabaseMigrationService
For internal use only
describePendingMaintenanceActions
in interface AWSDatabaseMigrationService
public DescribeRecommendationLimitationsResult describeRecommendationLimitations(DescribeRecommendationLimitationsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
describeRecommendationLimitations
in interface AWSDatabaseMigrationService
public DescribeRecommendationsResult describeRecommendations(DescribeRecommendationsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of target engine recommendations for your source databases.
describeRecommendations
in interface AWSDatabaseMigrationService
public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
AWSDatabaseMigrationService
Returns the status of the RefreshSchemas operation.
describeRefreshSchemasStatus
in interface AWSDatabaseMigrationService
public DescribeReplicationConfigsResult describeReplicationConfigs(DescribeReplicationConfigsRequest request)
AWSDatabaseMigrationService
Returns one or more existing DMS Serverless replication configurations as a list of structures.
describeReplicationConfigs
in interface AWSDatabaseMigrationService
public DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs(DescribeReplicationInstanceTaskLogsRequest request)
AWSDatabaseMigrationService
Returns information about the task logs for the specified task.
describeReplicationInstanceTaskLogs
in interface AWSDatabaseMigrationService
public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)
AWSDatabaseMigrationService
Returns information about replication instances for your account in the current region.
describeReplicationInstances
in interface AWSDatabaseMigrationService
public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
AWSDatabaseMigrationService
Returns information about the replication subnet groups.
describeReplicationSubnetGroups
in interface AWSDatabaseMigrationService
public DescribeReplicationTableStatisticsResult describeReplicationTableStatistics(DescribeReplicationTableStatisticsRequest request)
AWSDatabaseMigrationService
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.
describeReplicationTableStatistics
in interface AWSDatabaseMigrationService
public DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults(DescribeReplicationTaskAssessmentResultsRequest request)
AWSDatabaseMigrationService
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.
For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
describeReplicationTaskAssessmentResults
in interface AWSDatabaseMigrationService
public DescribeReplicationTaskAssessmentRunsResult describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of premigration assessment runs based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
This operation doesn't return information about individual assessments. For this information, see the
DescribeReplicationTaskIndividualAssessments
operation.
describeReplicationTaskAssessmentRuns
in interface AWSDatabaseMigrationService
public DescribeReplicationTaskIndividualAssessmentsResult describeReplicationTaskIndividualAssessments(DescribeReplicationTaskIndividualAssessmentsRequest request)
AWSDatabaseMigrationService
Returns a paginated list of individual assessments based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
describeReplicationTaskIndividualAssessments
in interface AWSDatabaseMigrationService
public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)
AWSDatabaseMigrationService
Returns information about replication tasks for your account in the current region.
describeReplicationTasks
in interface AWSDatabaseMigrationService
public DescribeReplicationsResult describeReplications(DescribeReplicationsRequest request)
AWSDatabaseMigrationService
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
describeReplications
in interface AWSDatabaseMigrationService
public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)
AWSDatabaseMigrationService
Returns information about the schema for the specified endpoint.
describeSchemas
in interface AWSDatabaseMigrationService
public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest request)
AWSDatabaseMigrationService
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
describeTableStatistics
in interface AWSDatabaseMigrationService
public ExportMetadataModelAssessmentResult exportMetadataModelAssessment(ExportMetadataModelAssessmentRequest request)
AWSDatabaseMigrationService
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.
exportMetadataModelAssessment
in interface AWSDatabaseMigrationService
public ImportCertificateResult importCertificate(ImportCertificateRequest request)
AWSDatabaseMigrationService
Uploads the specified certificate.
importCertificate
in interface AWSDatabaseMigrationService
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSDatabaseMigrationService
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and
migration task. For more information, see Tag
data type
description.
listTagsForResource
in interface AWSDatabaseMigrationService
public ModifyConversionConfigurationResult modifyConversionConfiguration(ModifyConversionConfigurationRequest request)
AWSDatabaseMigrationService
Modifies the specified schema conversion configuration using the provided parameters.
modifyConversionConfiguration
in interface AWSDatabaseMigrationService
public ModifyDataProviderResult modifyDataProvider(ModifyDataProviderRequest request)
AWSDatabaseMigrationService
Modifies the specified data provider using the provided settings.
You must remove the data provider from all migration projects before you can modify it.
modifyDataProvider
in interface AWSDatabaseMigrationService
public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)
AWSDatabaseMigrationService
Modifies the specified endpoint.
For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName
request parameter on the ModifyEndpoint
API call. Specifying DatabaseName
when you
modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify
the database only when you specify the schema in the table-mapping rules of the DMS task.
modifyEndpoint
in interface AWSDatabaseMigrationService
public ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest request)
AWSDatabaseMigrationService
Modifies an existing DMS event notification subscription.
modifyEventSubscription
in interface AWSDatabaseMigrationService
public ModifyInstanceProfileResult modifyInstanceProfile(ModifyInstanceProfileRequest request)
AWSDatabaseMigrationService
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.
modifyInstanceProfile
in interface AWSDatabaseMigrationService
public ModifyMigrationProjectResult modifyMigrationProject(ModifyMigrationProjectRequest request)
AWSDatabaseMigrationService
Modifies the specified migration project using the provided parameters.
The migration project must be closed before you can modify it.
modifyMigrationProject
in interface AWSDatabaseMigrationService
public ModifyReplicationConfigResult modifyReplicationConfig(ModifyReplicationConfigRequest request)
AWSDatabaseMigrationService
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.
modifyReplicationConfig
in interface AWSDatabaseMigrationService
public ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest request)
AWSDatabaseMigrationService
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
modifyReplicationInstance
in interface AWSDatabaseMigrationService
public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
AWSDatabaseMigrationService
Modifies the settings for the specified replication subnet group.
modifyReplicationSubnetGroup
in interface AWSDatabaseMigrationService
public ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest request)
AWSDatabaseMigrationService
Modifies the specified replication task.
You can't modify the task endpoints. The task must be stopped before you can modify it.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
modifyReplicationTask
in interface AWSDatabaseMigrationService
public MoveReplicationTaskResult moveReplicationTask(MoveReplicationTaskRequest request)
AWSDatabaseMigrationService
Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
moveReplicationTask
in interface AWSDatabaseMigrationService
public RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest request)
AWSDatabaseMigrationService
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
rebootReplicationInstance
in interface AWSDatabaseMigrationService
public RefreshSchemasResult refreshSchemas(RefreshSchemasRequest request)
AWSDatabaseMigrationService
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
refreshSchemas
in interface AWSDatabaseMigrationService
public ReloadReplicationTablesResult reloadReplicationTables(ReloadReplicationTablesRequest request)
AWSDatabaseMigrationService
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.
reloadReplicationTables
in interface AWSDatabaseMigrationService
public ReloadTablesResult reloadTables(ReloadTablesRequest request)
AWSDatabaseMigrationService
Reloads the target database table with the source data.
You can only use this operation with a task in the RUNNING
state, otherwise the service will throw
an InvalidResourceStateFault
exception.
reloadTables
in interface AWSDatabaseMigrationService
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSDatabaseMigrationService
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration
task. For more information, see
Tag
data type description.
removeTagsFromResource
in interface AWSDatabaseMigrationService
request
- Removes one or more tags from an DMS resource.public RunFleetAdvisorLsaAnalysisResult runFleetAdvisorLsaAnalysis(RunFleetAdvisorLsaAnalysisRequest request)
AWSDatabaseMigrationService
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
runFleetAdvisorLsaAnalysis
in interface AWSDatabaseMigrationService
public StartExtensionPackAssociationResult startExtensionPackAssociation(StartExtensionPackAssociationRequest request)
AWSDatabaseMigrationService
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.
startExtensionPackAssociation
in interface AWSDatabaseMigrationService
public StartMetadataModelAssessmentResult startMetadataModelAssessment(StartMetadataModelAssessmentRequest request)
AWSDatabaseMigrationService
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.
startMetadataModelAssessment
in interface AWSDatabaseMigrationService
public StartMetadataModelConversionResult startMetadataModelConversion(StartMetadataModelConversionRequest request)
AWSDatabaseMigrationService
Converts your source database objects to a format compatible with the target database.
startMetadataModelConversion
in interface AWSDatabaseMigrationService
public StartMetadataModelExportAsScriptResult startMetadataModelExportAsScript(StartMetadataModelExportAsScriptRequest request)
AWSDatabaseMigrationService
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
startMetadataModelExportAsScript
in interface AWSDatabaseMigrationService
public StartMetadataModelExportToTargetResult startMetadataModelExportToTarget(StartMetadataModelExportToTargetRequest request)
AWSDatabaseMigrationService
Applies converted database objects to your target database.
startMetadataModelExportToTarget
in interface AWSDatabaseMigrationService
public StartMetadataModelImportResult startMetadataModelImport(StartMetadataModelImportRequest request)
AWSDatabaseMigrationService
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.
startMetadataModelImport
in interface AWSDatabaseMigrationService
public StartRecommendationsResult startRecommendations(StartRecommendationsRequest request)
AWSDatabaseMigrationService
Starts the analysis of your source database to provide recommendations of target engines.
You can create recommendations for multiple source databases using BatchStartRecommendations.
startRecommendations
in interface AWSDatabaseMigrationService
public StartReplicationResult startReplication(StartReplicationRequest request)
AWSDatabaseMigrationService
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.
startReplication
in interface AWSDatabaseMigrationService
public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)
AWSDatabaseMigrationService
Starts the replication task.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
startReplicationTask
in interface AWSDatabaseMigrationService
public StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest request)
AWSDatabaseMigrationService
Starts the replication task assessment for unsupported data types in the source database.
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.
startReplicationTaskAssessment
in interface AWSDatabaseMigrationService
public StartReplicationTaskAssessmentRunResult startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest request)
AWSDatabaseMigrationService
Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
startReplicationTaskAssessmentRun
in interface AWSDatabaseMigrationService
public StopReplicationResult stopReplication(StopReplicationRequest request)
AWSDatabaseMigrationService
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
stopReplication
in interface AWSDatabaseMigrationService
public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)
AWSDatabaseMigrationService
Stops the replication task.
stopReplicationTask
in interface AWSDatabaseMigrationService
public TestConnectionResult testConnection(TestConnectionRequest request)
AWSDatabaseMigrationService
Tests the connection between the replication instance and the endpoint.
testConnection
in interface AWSDatabaseMigrationService
public UpdateSubscriptionsToEventBridgeResult updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest request)
AWSDatabaseMigrationService
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.
updateSubscriptionsToEventBridge
in interface AWSDatabaseMigrationService
public void shutdown()
AWSDatabaseMigrationService
shutdown
in interface AWSDatabaseMigrationService
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSDatabaseMigrationService
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSDatabaseMigrationService
request
- The originally executed request.public AWSDatabaseMigrationServiceWaiters waiters()
waiters
in interface AWSDatabaseMigrationService