Skip to content

PremigrationAssessmentStatus

Source code in docs_src/capo_database_migration_service/types/premigration_assessment_status.py
class PremigrationAssessmentStatus(TypedDict, closed=True):
    premigration_assessment_run_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Amazon Resource Name (ARN) of this assessment run.</p>"""
    fail_on_assessment_failure: "capo_database_migration_service.types.boolean.Boolean"
    """<p>A configurable setting you can set to <code>true</code> (the defualt setting) or <code>false</code>. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.</p>"""
    status: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>This describes the assessment run status. The status can be one of the following values:</p> <ul> <li> <p> <code>cancelling</code>: The assessment run was canceled.</p> </li> <li> <p> <code>deleting</code>: The assessment run was deleted.</p> </li> <li> <p> <code>failed</code>: At least one individual assessment completed with a failed status. </p> </li> <li> <p> <code>error-provisioning</code>: An internal error occurred while resources were provisioned (during the <code>provisioning</code> status).</p> </li> <li> <p> <code>error-executing</code> An internal error occurred while individual assessments ran (during the <code>running</code> status).</p> </li> <li> <p> <code>invalid state</code>: The assessment run is in an unknown state. </p> </li> <li> <p> <code>passed</code>: All individual assessments have completed and none have a failed status.</p> </li> <li> <p> <code>provisioning</code>: The resources required to run individual assessments are being provisioned. </p> </li> <li> <p> <code>running</code>: Individual assessments are being run. </p> </li> <li> <p> <code>starting</code>: The assessment run is starting, but resources are not yet being provisioned for individual assessments. </p> </li> <li> <p> <code>warning</code>: At least one individual assessment completed with a warning status. </p> </li> </ul>"""
    premigration_assessment_run_creation_date: NotRequired[
        "capo_database_migration_service.types.t_stamp.TStamp"
    ]
    """<p>The date which the assessment run was created.</p>"""
    assessment_progress: NotRequired[
        "capo_database_migration_service.types.replication_task_assessment_run_progress.ReplicationTaskAssessmentRunProgress"
    ]
    last_failure_message: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The last message generated by an individual assessment failure.</p>"""
    result_location_bucket: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.</p>"""
    result_location_folder: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.</p>"""
    result_encryption_mode: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The supported values are <code>SSE_KMS</code> and <code>SSE_S3</code>. If these values are not provided, then the files are not encrypted at rest. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.KMSKeys">Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects</a>.</p>"""
    result_kms_key_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The ARN of a custom KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>SSE_KMS</code>.</p>"""
    result_statistic: NotRequired[
        "capo_database_migration_service.types.replication_task_assessment_run_result_statistic.ReplicationTaskAssessmentRunResultStatistic"
    ]

assessment_progress instance-attribute

assessment_progress: NotRequired[ReplicationTaskAssessmentRunProgress]

fail_on_assessment_failure instance-attribute

fail_on_assessment_failure: Boolean

A configurable setting you can set to true (the defualt setting) or false. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.

last_failure_message instance-attribute

last_failure_message: NotRequired[String]

The last message generated by an individual assessment failure.

premigration_assessment_run_arn instance-attribute

premigration_assessment_run_arn: NotRequired[String]

The Amazon Resource Name (ARN) of this assessment run.

premigration_assessment_run_creation_date instance-attribute

premigration_assessment_run_creation_date: NotRequired[TStamp]

The date which the assessment run was created.

result_encryption_mode instance-attribute

result_encryption_mode: NotRequired[String]

The supported values are SSE_KMS and SSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.

result_kms_key_arn instance-attribute

result_kms_key_arn: NotRequired[String]

The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.

result_location_bucket instance-attribute

result_location_bucket: NotRequired[String]

The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.

result_location_folder instance-attribute

result_location_folder: NotRequired[String]

The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.

result_statistic instance-attribute

result_statistic: NotRequired[ReplicationTaskAssessmentRunResultStatistic]

status instance-attribute

status: NotRequired[String]

This describes the assessment run status. The status can be one of the following values:

  • cancelling: The assessment run was canceled.

  • deleting: The assessment run was deleted.

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

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

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

  • invalid state: The assessment run is in an unknown state.

  • passed: All individual assessments have completed and none have a failed status.

  • provisioning: The 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.