StopDataMigration - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

StopDataMigration

Stops the specified data migration.

Request Syntax

{ "DataMigrationIdentifier": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DataMigrationIdentifier

The identifier (name or ARN) of the data migration to stop.

Type: String

Required: Yes

Response Syntax

{ "DataMigration": { "DataMigrationArn": "string", "DataMigrationCidrBlocks": [ "string" ], "DataMigrationCreateTime": "string", "DataMigrationEndTime": "string", "DataMigrationName": "string", "DataMigrationSettings": { "CloudwatchLogsEnabled": boolean, "NumberOfJobs": number, "SelectionRules": "string" }, "DataMigrationStartTime": "string", "DataMigrationStatistics": { "CDCLatency": number, "ElapsedTimeMillis": number, "FullLoadPercentage": number, "StartTime": "string", "StopTime": "string", "TablesErrored": number, "TablesLoaded": number, "TablesLoading": number, "TablesQueued": number }, "DataMigrationStatus": "string", "DataMigrationType": "string", "LastFailureMessage": "string", "MigrationProjectArn": "string", "PublicIpAddresses": [ "string" ], "ServiceAccessRoleArn": "string", "SourceDataSettings": [ { "CDCStartPosition": "string", "CDCStartTime": "string", "CDCStopTime": "string", "SlotName": "string" } ], "StopReason": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DataMigration

The data migration that DMS stopped.

Type: DataMigration object

Errors

For information about the errors that are common to all actions, see Common Errors.

FailedDependencyFault

A dependency threw an exception.

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: