Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StopReplication

For a given Amazon DMS Serverless replication configuration, Amazon DMS stops any and all ongoing Amazon DMS Serverless replications. This command doesn't deprovision the stopped replications.

Request Syntax


{
   "ReplicationConfigArn": "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.

ReplicationConfigArn

The Amazon Resource Name of the replication to stop.

Type: String

Required: Yes

Response Syntax


{
   "Replication": { 
      "CdcStartPosition": "string",
      "CdcStartTime": number,
      "CdcStopPosition": "string",
      "FailureMessages": [ "string" ],
      "ProvisionData": { 
         "DateNewProvisioningDataAvailable": number,
         "DateProvisioned": number,
         "IsNewProvisioningAvailable": boolean,
         "ProvisionedCapacityUnits": number,
         "ProvisionState": "string",
         "ReasonForNewProvisioningData": "string"
      },
      "RecoveryCheckpoint": "string",
      "ReplicationConfigArn": "string",
      "ReplicationConfigIdentifier": "string",
      "ReplicationCreateTime": number,
      "ReplicationDeprovisionTime": number,
      "ReplicationLastStopTime": number,
      "ReplicationStats": { 
         "ElapsedTimeMillis": number,
         "FreshStartDate": number,
         "FullLoadFinishDate": number,
         "FullLoadProgressPercent": number,
         "FullLoadStartDate": number,
         "StartDate": number,
         "StopDate": number,
         "TablesErrored": number,
         "TablesLoaded": number,
         "TablesLoading": number,
         "TablesQueued": number
      },
      "ReplicationType": "string",
      "ReplicationUpdateTime": number,
      "SourceEndpointArn": "string",
      "StartReplicationType": "string",
      "Status": "string",
      "StopReason": "string",
      "TargetEndpointArn": "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.

Replication

The replication that Amazon DMS stopped.

Type: Replication object

Errors

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

AccessDeniedFault

Amazon 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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StopReplication.

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.StopReplication
{   
   "ReplicationConfigArn":"arn:aws:dms:us-east
1:123456789012:replication-config:RALPZGYI3IUSJCBKKIRBEURKDY"
}

Sample Response



HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
   "Replication": {
      {
         "SourceEndpointArn": "arn:aws:dms:us-west-
2:123456789012:endpoint:5OFSBLSONLVVSYQAY7IBDSMCEHD6NU4FJQ5L7XY", 
         "Status": "created", 
         "ReplicationConfigIdentifier": "serverless-kms-0", 
         "ReplicationStats": {
            "TablesLoading": 0, 
            "TablesQueued": 0, 
            "TablesErrored": 0, 
            "FullLoadProgressPercent": 0, 
            "TablesLoaded": 0, 
            "ElapsedTimeMillis": 0
         }, 
         "ReplicationCreateTime": 1679665872.025, 
         "ReplicationConfigArn": "arn:aws:dms:us-east
1:123456789012:replication-config:RALPZGYI3IUSJCBKKIRBEURKDY", 
         "ReplicationType": "full-load-and-cdc", 
         "ReplicationUpdateTime": 1679665872.025, 
         "ProvisionData": {
            "IsNewProvisioningAvailable": false, 
            "ProvisionedCapacityUnits": 0
         }, 
         "TargetEndpointArn": "arn:aws:dms:us-west-
2:123456789012:endpoint:WTMG7G6X5TQ5GOQG46WGEBNMPDSH47J5JZHXUFI", 
         "FailureMessages": []
      }
   }
}