DatabaseMigrationService / Client / describe_replication_task_individual_assessments

describe_replication_task_individual_assessments#

DatabaseMigrationService.Client.describe_replication_task_individual_assessments(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_task_individual_assessments(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • Filters (list) –

    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

    • (dict) –

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (string) –

  • 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.

  • 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',
    'ReplicationTaskIndividualAssessments': [
        {
            'ReplicationTaskIndividualAssessmentArn': 'string',
            'ReplicationTaskAssessmentRunArn': 'string',
            'IndividualAssessmentName': 'string',
            'Status': 'string',
            'ReplicationTaskIndividualAssessmentStartDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      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.

    • ReplicationTaskIndividualAssessments (list) –

      One or more individual assessments as specified by Filters.

      • (dict) –

        Provides information that describes an individual assessment from a premigration assessment run.

        • ReplicationTaskIndividualAssessmentArn (string) –

          Amazon Resource Name (ARN) of this individual assessment.

        • ReplicationTaskAssessmentRunArn (string) –

          ARN of the premigration assessment run that is created to run this individual assessment.

        • IndividualAssessmentName (string) –

          Name of this individual assessment.

        • Status (string) –

          Individual assessment status.

          This status can have one of the following values:

          • "cancelled"

          • "error"

          • "failed"

          • "passed"

          • "pending"

          • "running"

        • ReplicationTaskIndividualAssessmentStartDate (datetime) –

          Date when this individual assessment was started as part of running the StartReplicationTaskAssessmentRun operation.

Exceptions