DatabaseMigrationService / Client / cancel_replication_task_assessment_run

cancel_replication_task_assessment_run#

DatabaseMigrationService.Client.cancel_replication_task_assessment_run(**kwargs)#

Cancels a single premigration assessment run.

This operation prevents any individual assessments from running if they haven’t started running. It also attempts to cancel any individual assessments that are currently running.

See also: AWS API Documentation

Request Syntax

response = client.cancel_replication_task_assessment_run(
    ReplicationTaskAssessmentRunArn='string'
)
Parameters:

ReplicationTaskAssessmentRunArn (string) –

[REQUIRED]

Amazon Resource Name (ARN) of the premigration assessment run to be canceled.

Return type:

dict

Returns:

Response Syntax

{
    'ReplicationTaskAssessmentRun': {
        '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) –

    • ReplicationTaskAssessmentRun (dict) –

      The ReplicationTaskAssessmentRun object for the canceled assessment run.

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

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

      • 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