Skip to content

ClarifyCheckStepMetadata

Source code in docs_src/capo_sagemaker/types/clarify_check_step_metadata.py
class ClarifyCheckStepMetadata(TypedDict, closed=True):
    check_type: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>The type of the Clarify Check step</p>"""
    baseline_used_for_drift_check_constraints: NotRequired[
        "capo_sagemaker.types.string1024.String1024"
    ]
    """<p>The Amazon S3 URI of baseline constraints file to be used for the drift check.</p>"""
    calculated_baseline_constraints: NotRequired[
        "capo_sagemaker.types.string1024.String1024"
    ]
    """<p>The Amazon S3 URI of the newly calculated baseline constraints file.</p>"""
    model_package_group_name: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>The model package group name.</p>"""
    violation_report: NotRequired["capo_sagemaker.types.string1024.String1024"]
    """<p>The Amazon S3 URI of the violation report if violations are detected.</p>"""
    check_job_arn: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.</p>"""
    skip_check: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to <code>False</code>, the previous baseline of the configured check type must be available.</p>"""
    register_new_baseline: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>This flag indicates if a newly calculated baseline can be accessed through step properties <code>BaselineUsedForDriftCheckConstraints</code> and <code>BaselineUsedForDriftCheckStatistics</code>. If it is set to <code>False</code>, the previous baseline of the configured check type must also be available. These can be accessed through the <code>BaselineUsedForDriftCheckConstraints</code> property. </p>"""

baseline_used_for_drift_check_constraints instance-attribute

baseline_used_for_drift_check_constraints: NotRequired[String1024]

The Amazon S3 URI of baseline constraints file to be used for the drift check.

calculated_baseline_constraints instance-attribute

calculated_baseline_constraints: NotRequired[String1024]

The Amazon S3 URI of the newly calculated baseline constraints file.

check_job_arn instance-attribute

check_job_arn: NotRequired[String256]

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

check_type instance-attribute

check_type: NotRequired[String256]

The type of the Clarify Check step

model_package_group_name instance-attribute

model_package_group_name: NotRequired[String256]

The model package group name.

register_new_baseline instance-attribute

register_new_baseline: NotRequired[Boolean]

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

skip_check instance-attribute

skip_check: NotRequired[Boolean]

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

violation_report instance-attribute

violation_report: NotRequired[String1024]

The Amazon S3 URI of the violation report if violations are detected.