MoveReplicationTask - AWS Database Migration Service

MoveReplicationTask

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 AWS DMS version as the current replication instance.

Request Syntax

{ "ReplicationTaskArn": "string", "TargetReplicationInstanceArn": "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.

ReplicationTaskArn

The Amazon Resource Name (ARN) of the task that you want to move.

Type: String

Required: Yes

TargetReplicationInstanceArn

The ARN of the replication instance where you want to move the task to.

Type: String

Required: Yes

Response Syntax

{ "ReplicationTask": { "CdcStartPosition": "string", "CdcStopPosition": "string", "LastFailureMessage": "string", "MigrationType": "string", "RecoveryCheckpoint": "string", "ReplicationInstanceArn": "string", "ReplicationTaskArn": "string", "ReplicationTaskCreationDate": number, "ReplicationTaskIdentifier": "string", "ReplicationTaskSettings": "string", "ReplicationTaskStartDate": number, "ReplicationTaskStats": { "ElapsedTimeMillis": number, "FreshStartDate": number, "FullLoadFinishDate": number, "FullLoadProgressPercent": number, "FullLoadStartDate": number, "StartDate": number, "StopDate": number, "TablesErrored": number, "TablesLoaded": number, "TablesLoading": number, "TablesQueued": number }, "SourceEndpointArn": "string", "Status": "string", "StopReason": "string", "TableMappings": "string", "TargetEndpointArn": "string", "TargetReplicationInstanceArn": "string", "TaskData": "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.

ReplicationTask

The replication task that was moved.

Type: ReplicationTask object

Errors

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

AccessDeniedFault

AWS DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400

InvalidResourceStateFault

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

HTTP Status Code: 400

KMSKeyNotAccessibleFault

AWS DMS cannot access the KMS key.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

ResourceQuotaExceededFault

The quota for this resource quota has been exceeded.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of MoveReplicationTask.

Sample Request

POST / HTTP/1.1 Host: dms.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AmazonDMSv20160101.MoveReplicationTask { "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:GBQBVYT7IIWCUUE44KI7ITKAK2OIURGWGDR4QZY", "TargetReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:UMBQHEHRZ2WG23LSVP767KHNWGHSXVTTSSUXZCI" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "ReplicationTask": { "ReplicationTaskIdentifier": "task-test", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GDBXFEKRITMGQO2POUA6VHZPIY", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:DIGHLLJZKQUN3VEF2MQC7D4VNE", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:HBNEJHHRZ2WG23LSVP767KHNWGHSXVTTSASHB", "MigrationType": "full-load-and-cdc", "TableMappings": "{\n \"TableMappings\": [ \n {\n \"Type\": \"Include\",\n \"SourceSchema\": \"/\",\n \"SourceTable\": \"/\"\n }\n ]\n}\n\n", "ReplicationTaskSettings": "", "Status": "moving", "ReplicationTaskCreationDate": 1595513932.394 "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:GBQBVYT7IIWCUUE44KI7ITKAK2OIURGWGDR4QZY", "TargetReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:UMBQHEHRZ2WG23LSVP767KHNWGHSXVTTSSUXZCI" } }

See Also

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