DescribeReplicationTaskAssessmentRuns - AWS Database Migration Service


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.

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 applied to the premigration assessment runs described in the form of key-value pairs.

Valid filter names: replication-task-assessment-run-arn, replication-task-arn, replication-instance-arn, status

Type: Array of Filter objects

Required: No


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


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", "ReplicationTaskAssessmentRuns": [ { "AssessmentProgress": { "IndividualAssessmentCompletedCount": number, "IndividualAssessmentCount": number }, "AssessmentRunName": "string", "LastFailureMessage": "string", "ReplicationTaskArn": "string", "ReplicationTaskAssessmentRunArn": "string", "ReplicationTaskAssessmentRunCreationDate": number, "ResultEncryptionMode": "string", "ResultKmsKeyArn": "string", "ResultLocationBucket": "string", "ResultLocationFolder": "string", "ServiceAccessRoleArn": "string", "Status": "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.


A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.

Type: String


One or more premigration assessment runs as specified by Filters.

Type: Array of ReplicationTaskAssessmentRun objects


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


The resource could not be found.

HTTP Status Code: 400



This example illustrates one usage of DescribeReplicationTaskAssessmentRuns.

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.DescribeReplicationTaskAssessmentRuns { "Filters": [ { "Name": "replication-task-arn", "Values": [ "arn:aws:dms:us-west-2:123456789012:task:Z5GKNMVRGGFINESYJIQHG4RLONJGRSRVLCBTECQ" ] } ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "ReplicationTaskAssessmentRuns": [ { "AssessmentProgress": { "IndividualAssessmentCompletedCount": 3, "IndividualAssessmentCount": 3 }, "AssessmentRunName": "Assessment-run-2020-07-07-18-15-03", "ReplicationTaskArn": "arn:aws:dms:us-west-2:123456789012:task:Z5GKNMVRGGFINESYJIQHG4RLONJGRSRVLCBTECQ", "ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:OGH64BOBSW535SPB5RFJAU7OCYEHXZTWWUGCXZA", "ReplicationTaskAssessmentRunCreationDate": 1594170933.203, "ResultEncryptionMode": "NONE", "ResultLocationBucket": "myBucket", "ResultLocationFolder": "myFolder", "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/Admin", "Status": "passed" } ] }

See Also

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