Skip to content

/AWS1/CL_SGMCLARIFYCHKSTEPMET

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_checktype TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

The type of the Clarify Check step

iv_baselineusedfordriftche00 TYPE /AWS1/SGMSTRING1024 /AWS1/SGMSTRING1024

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

iv_calculatedbaselinecnstr00 TYPE /AWS1/SGMSTRING1024 /AWS1/SGMSTRING1024

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

iv_modelpackagegroupname TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

The model package group name.

iv_violationreport TYPE /AWS1/SGMSTRING1024 /AWS1/SGMSTRING1024

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

iv_checkjobarn TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

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

iv_skipcheck TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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.

iv_registernewbaseline TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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.


Queryable Attributes

CheckType

The type of the Clarify Check step

Accessible with the following methods

Method Description
GET_CHECKTYPE() Getter for CHECKTYPE, with configurable default
ASK_CHECKTYPE() Getter for CHECKTYPE w/ exceptions if field has no value
HAS_CHECKTYPE() Determine if CHECKTYPE has a value

BaselineUsedForDriftCheckConstraints

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

Accessible with the following methods

Method Description
GET_BASELINEUSEDFORDRIFTCH01() Getter for BASELINEUSEDFORDRIFTCHECKC00, with configurable d
ASK_BASELINEUSEDFORDRIFTCH01() Getter for BASELINEUSEDFORDRIFTCHECKC00 w/ exceptions if fie
HAS_BASELINEUSEDFORDRIFTCH01() Determine if BASELINEUSEDFORDRIFTCHECKC00 has a value

CalculatedBaselineConstraints

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

Accessible with the following methods

Method Description
GET_CALCULATEDBASELINECNST00() Getter for CALCULATEDBASELINECNSTRNTS, with configurable def
ASK_CALCULATEDBASELINECNST00() Getter for CALCULATEDBASELINECNSTRNTS w/ exceptions if field
HAS_CALCULATEDBASELINECNST00() Determine if CALCULATEDBASELINECNSTRNTS has a value

ModelPackageGroupName

The model package group name.

Accessible with the following methods

Method Description
GET_MODELPACKAGEGROUPNAME() Getter for MODELPACKAGEGROUPNAME, with configurable default
ASK_MODELPACKAGEGROUPNAME() Getter for MODELPACKAGEGROUPNAME w/ exceptions if field has
HAS_MODELPACKAGEGROUPNAME() Determine if MODELPACKAGEGROUPNAME has a value

ViolationReport

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

Accessible with the following methods

Method Description
GET_VIOLATIONREPORT() Getter for VIOLATIONREPORT, with configurable default
ASK_VIOLATIONREPORT() Getter for VIOLATIONREPORT w/ exceptions if field has no val
HAS_VIOLATIONREPORT() Determine if VIOLATIONREPORT has a value

CheckJobArn

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

Accessible with the following methods

Method Description
GET_CHECKJOBARN() Getter for CHECKJOBARN, with configurable default
ASK_CHECKJOBARN() Getter for CHECKJOBARN w/ exceptions if field has no value
HAS_CHECKJOBARN() Determine if CHECKJOBARN has a value

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.

Accessible with the following methods

Method Description
GET_SKIPCHECK() Getter for SKIPCHECK, with configurable default
ASK_SKIPCHECK() Getter for SKIPCHECK w/ exceptions if field has no value
HAS_SKIPCHECK() Determine if SKIPCHECK has a value

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

Accessible with the following methods

Method Description
GET_REGISTERNEWBASELINE() Getter for REGISTERNEWBASELINE, with configurable default
ASK_REGISTERNEWBASELINE() Getter for REGISTERNEWBASELINE w/ exceptions if field has no
HAS_REGISTERNEWBASELINE() Determine if REGISTERNEWBASELINE has a value