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

DescribeReplications

Provides details on replication progress by returning status information for one or more provisioned Amazon DMS Serverless replications.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Marker": "string",
   "MaxRecords": number
}

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.

Filters

Filters applied to the replications.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No

Response Syntax


{
   "Marker": "string",
   "Replications": [ 
      { 
         "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.

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Replications

The replication descriptions.

Type: Array of Replication objects

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeReplications.

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.DescribeReplications
{   
   "Filters":[
      {
         "Name":"endpoint-arn",
         "Values":[
            "arn:aws:dms:us-east
1:123456789012:endpoint:WTMG7G6X5TQ5GOQG46WGEBNMPDSH47J5JZHXUFI"
         ]
      }
   ],
   "MaxRecords":0,
   "Marker":""
}

Sample Response



HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
   "Replications": {
      {
         "SourceEndpointArn": "arn:aws:dms:us-east-
1: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:ZKIB7GSLEJ2CIG5I6FGI6OR6Y25RRIDGG4H5OCY", 
         "ReplicationType": "full-load-and-cdc", 
         "ReplicationUpdateTime": 1679665872.025, 
         "ProvisionData": {
             "IsNewProvisioningAvailable": false, 
             "ProvisionedCapacityUnits": 0
         }, 
         "TargetEndpointArn": "arn:aws:dms:us-west-
2:123456789012:endpoint:WTMG7G6X5TQ5GOQG46WGEBNMPDSH47J5JZHXUFI", 
         "FailureMessages": []
      }
   }
}