DatabaseMigrationService / Client / start_replication_task_assessment_run

start_replication_task_assessment_run#

DatabaseMigrationService.Client.start_replication_task_assessment_run(**kwargs)#

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

See also: AWS API Documentation

Request Syntax

response = client.start_replication_task_assessment_run(
    ReplicationTaskArn='string',
    ServiceAccessRoleArn='string',
    ResultLocationBucket='string',
    ResultLocationFolder='string',
    ResultEncryptionMode='string',
    ResultKmsKeyArn='string',
    AssessmentRunName='string',
    IncludeOnly=[
        'string',
    ],
    Exclude=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string',
            'ResourceArn': 'string'
        },
    ]
)
Parameters:

  • ReplicationTaskArn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

  • ServiceAccessRoleArn (string) –

    [REQUIRED]

    ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

  • ResultLocationBucket (string) –

    [REQUIRED]

    Amazon S3 bucket where you want DMS to store the results of this assessment run.

  • ResultLocationFolder (string) – Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

  • ResultEncryptionMode (string) –

    Encryption mode that you can specify to encrypt the results of this assessment run. If you don’t specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

    • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.

    • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.

  • ResultKmsKeyArn (string) – ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS”.

  • AssessmentRunName (string) –

    [REQUIRED]

    Unique name to identify the assessment run.

  • IncludeOnly (list) –

    Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    Note

    You can’t set a value for IncludeOnly if you also set a value for Exclude in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

    • (string) –

  • Exclude (list) –

    Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    Note

    You can’t set a value for Exclude if you also set a value for IncludeOnly in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

    • (string) –

  • Tags (list) –

    One or more tags to be assigned to the premigration assessment run that you want to start.

    • (dict) –

      A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

      • AddTagsToResource

      • ListTagsForResource

      • RemoveTagsFromResource

      • Key (string) –

        A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

      • Value (string) –

        A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

      • ResourceArn (string) –

        The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

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 premigration assessment run that was started.

      • 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