DatabaseMigrationService / Client / describe_replication_task_assessment_results

describe_replication_task_assessment_results#

DatabaseMigrationService.Client.describe_replication_task_assessment_results(**kwargs)#

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.

For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_task_assessment_results(
    ReplicationTaskArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • ReplicationTaskArn (string) – The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.

  • MaxRecords (integer) –

    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.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'BucketName': 'string',
    'ReplicationTaskAssessmentResults': [
        {
            'ReplicationTaskIdentifier': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskLastAssessmentDate': datetime(2015, 1, 1),
            'AssessmentStatus': 'string',
            'AssessmentResultsFile': 'string',
            'AssessmentResults': 'string',
            'S3ObjectUrl': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      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.

    • BucketName (string) –

      • The Amazon S3 bucket where the task assessment report is located.

    • ReplicationTaskAssessmentResults (list) –

      The task assessment report.

      • (dict) –

        The task assessment report in JSON format.

        • ReplicationTaskIdentifier (string) –

          The replication task identifier of the task on which the task assessment was run.

        • ReplicationTaskArn (string) –

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskLastAssessmentDate (datetime) –

          The date the task assessment was completed.

        • AssessmentStatus (string) –

          The status of the task assessment.

        • AssessmentResultsFile (string) –

          The file containing the results of the task assessment.

        • AssessmentResults (string) –

          The task assessment results in JSON format.

          The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.

        • S3ObjectUrl (string) –

          The URL of the S3 object containing the task assessment results.

          The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.

Exceptions