DatabaseMigrationService / Client / describe_replication_task_assessment_runs

describe_replication_task_assessment_runs#

DatabaseMigrationService.Client.describe_replication_task_assessment_runs(**kwargs)#

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.

Note

This operation doesn’t return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.

See also: AWS API Documentation

Request Syntax

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

  • Filters (list) –

    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

    • (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',
    'ReplicationTaskAssessmentRuns': [
        {
            'ReplicationTaskAssessmentRunArn': 'string',
            'ReplicationTaskArn': 'string',
            'Status': 'string',
            'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
            'AssessmentProgress': {
                'IndividualAssessmentCount': 123,
                'IndividualAssessmentCompletedCount': 123
            },
            'LastFailureMessage': 'string',
            'ServiceAccessRoleArn': 'string',
            'ResultLocationBucket': 'string',
            'ResultLocationFolder': 'string',
            'ResultEncryptionMode': 'string',
            'ResultKmsKeyArn': 'string',
            'AssessmentRunName': 'string',
            'IsLatestTaskAssessmentRun': True|False,
            'ResultStatistic': {
                'Passed': 123,
                'Failed': 123,
                'Error': 123,
                'Warning': 123,
                'Cancelled': 123
            }
        },
    ]
}

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.

    • ReplicationTaskAssessmentRuns (list) –

      One or more premigration assessment runs as specified by Filters.

      • (dict) –

        Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

        Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.

        • ReplicationTaskAssessmentRunArn (string) –

          Amazon Resource Name (ARN) of this assessment run.

        • ReplicationTaskArn (string) –

          ARN of the migration task associated with this premigration assessment run.

        • Status (string) –

          Assessment run status.

          This status can have one of the following values:

          • "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.

          • "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.

          • "failed" – At least one individual assessment completed with a failed status.

          • "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).

          • "error-executing" – An internal error occurred while individual assessments ran (during running status).

          • "invalid state" – The assessment run is in an unknown state.

          • "passed" – All individual assessments have completed, and none has a failed status.

          • "provisioning" – Resources required to run individual assessments are being provisioned.

          • "running" – Individual assessments are being run.

          • "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.

        • ReplicationTaskAssessmentRunCreationDate (datetime) –

          Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

        • AssessmentProgress (dict) –

          Indication of the completion progress for the individual assessments specified to run.

          • IndividualAssessmentCount (integer) –

            The number of individual assessments that are specified to run.

          • IndividualAssessmentCompletedCount (integer) –

            The number of individual assessments that have completed, successfully or not.

        • LastFailureMessage (string) –

          Last message generated by an individual assessment failure.

        • ServiceAccessRoleArn (string) –

          ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

        • ResultLocationBucket (string) –

          Amazon S3 bucket where DMS stores the results of this assessment run.

        • ResultLocationFolder (string) –

          Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

        • ResultEncryptionMode (string) –

          Encryption mode used to encrypt the assessment run results.

        • ResultKmsKeyArn (string) –

          ARN of the KMS encryption key used to encrypt the assessment run results.

        • AssessmentRunName (string) –

          Unique name of the assessment run.

        • IsLatestTaskAssessmentRun (boolean) –

          Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

        • ResultStatistic (dict) –

          Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

          • Passed (integer) –

            The number of individual assessments that successfully passed all checks in the assessment run.

          • Failed (integer) –

            The number of individual assessments that failed to meet the criteria defined in the assessment run.

          • Error (integer) –

            The number of individual assessments that encountered a critical error and could not complete properly.

          • Warning (integer) –

            Indicates that the recent completed AssessmentRun triggered a warning.

          • Cancelled (integer) –

            The number of individual assessments that were cancelled during the assessment run.

Exceptions