Documentation

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

See: newQualityCheckStepMetadata smart constructor.

Create a value of QualityCheckStepMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:baselineUsedForDriftCheckConstraints:QualityCheckStepMetadata', qualityCheckStepMetadata_baselineUsedForDriftCheckConstraints - The Amazon S3 URI of the baseline constraints file used for the drift check.

$sel:baselineUsedForDriftCheckStatistics:QualityCheckStepMetadata', qualityCheckStepMetadata_baselineUsedForDriftCheckStatistics - The Amazon S3 URI of the baseline statistics file used for the drift check.

$sel:calculatedBaselineConstraints:QualityCheckStepMetadata', qualityCheckStepMetadata_calculatedBaselineConstraints - The Amazon S3 URI of the newly calculated baseline constraints file.

$sel:calculatedBaselineStatistics:QualityCheckStepMetadata', qualityCheckStepMetadata_calculatedBaselineStatistics - The Amazon S3 URI of the newly calculated baseline statistics file.

$sel:checkJobArn:QualityCheckStepMetadata', qualityCheckStepMetadata_checkJobArn - The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

$sel:checkType:QualityCheckStepMetadata', qualityCheckStepMetadata_checkType - The type of the Quality check step.

$sel:modelPackageGroupName:QualityCheckStepMetadata', qualityCheckStepMetadata_modelPackageGroupName - The model package group name.

$sel:registerNewBaseline:QualityCheckStepMetadata', qualityCheckStepMetadata_registerNewBaseline - 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 and BaselineUsedForDriftCheckStatistics properties.

$sel:skipCheck:QualityCheckStepMetadata', qualityCheckStepMetadata_skipCheck - 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.

$sel:violationReport:QualityCheckStepMetadata', qualityCheckStepMetadata_violationReport - The Amazon S3 URI of violation report if violations are detected.

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

The Amazon S3 URI of the baseline statistics file used for the drift check.

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

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

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

The type of the Quality check step.

The model package group name.

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 and BaselineUsedForDriftCheckStatistics properties.

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.

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