DescribeReplicationTaskIndividualAssessments - AWS Database Migration Service

DescribeReplicationTaskIndividualAssessments

Returns a paginated list of individual assessments based on filter settings.

These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.

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 individual assessments described in the form of key-value pairs.

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

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", "ReplicationTaskIndividualAssessments": [ { "IndividualAssessmentName": "string", "ReplicationTaskAssessmentRunArn": "string", "ReplicationTaskIndividualAssessmentArn": "string", "ReplicationTaskIndividualAssessmentStartDate": number, "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.

Marker

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

ReplicationTaskIndividualAssessments

One or more individual assessments as specified by Filters.

Type: Array of ReplicationTaskIndividualAssessment 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

Example

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.DescribeReplicationTaskIndividualAssessments { "Filters": [ { "Name": "replication-task-assessment-run-arn", "Values": [ "arn:aws:dms:us-west-2:123456789012:assessment-run:TSUXVACQ2UUMXUS5OYQOGXB6FXSAZ4LE3FXRNII", "arn:aws:dms:us-west-2:123456789012:assessment-run:ZQ3KWJEUM7SW2Q2BH5BFMPS525KH56C3G5DHMTQ", "arn:aws:dms:us-west-2:123456789012:assessment-run:3GOFKWZXGIT7ZWBBZOXDDBUS4VPAV63PPOQGFHQ" ] } ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "ReplicationTaskIndividualAssessments": [ { "IndividualAssessmentName": "unsupported-data-types-in-source", "ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:3GOFKWZXGIT7ZWBBZOXDDBUS4VPAV63PPOQGFHQ", "ReplicationTaskIndividualAssessmentArn": "arn:aws:dms:us-west-2:123456789012:individual-assessment:TSUXVACQ2UUMXUS5OYQOGXB6FXSAZ4LE3FXRNII", "ReplicationTaskIndividualAssessmentStartDate": 1594066482.995, "Status": "passed" }, { "IndividualAssessmentName": "full-lob-not-nullable-at-target", "ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:3GOFKWZXGIT7ZWBBZOXDDBUS4VPAV63PPOQGFHQ", "ReplicationTaskIndividualAssessmentArn": "arn:aws:dms:us-west-2:123456789012:individual-assessment:ZQ3KWJEUM7SW2Q2BH5BFMPS525KH56C3G5DHMTQ", "ReplicationTaskIndividualAssessmentStartDate": 1594066482.989, "Status": "passed" }, { "IndividualAssessmentName": "table-with-no-primary-key-or-unique-constraint", "ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:3GOFKWZXGIT7ZWBBZOXDDBUS4VPAV63PPOQGFHQ", "ReplicationTaskIndividualAssessmentArn": "arn:aws:dms:us-west-2:123456789012:individual-assessment:3GOFKWZXGIT7ZWBBZOXDDBUS4VPAV63PPOQGFHQ", "ReplicationTaskIndividualAssessmentStartDate": 1594066591.595, "Status": "passed" } ] }

See Also

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