Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.ClarifyCheckStepMetadata

Description

Synopsis

Documentation

data ClarifyCheckStepMetadata Source #

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

See: newClarifyCheckStepMetadata smart constructor.

Constructors

ClarifyCheckStepMetadata'

Fields

baselineUsedForDriftCheckConstraints :: Maybe Text
The Amazon S3 URI of baseline constraints file to be used for the drift check.
calculatedBaselineConstraints :: Maybe Text
The Amazon S3 URI of the newly calculated baseline constraints file.
checkJobArn :: Maybe Text
The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
checkType :: Maybe Text
The type of the Clarify Check step
modelPackageGroupName :: Maybe Text
The model package group name.
registerNewBaseline :: Maybe Bool
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.
skipCheck :: Maybe Bool
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.
violationReport :: Maybe Text
The Amazon S3 URI of the violation report if violations are detected.

Instances

Instances details

FromJSON ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods parseJSON :: Value -> Parser ClarifyCheckStepMetadata # parseJSONList :: Value -> Parser [ClarifyCheckStepMetadata] #
Generic ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Associated Types type Rep ClarifyCheckStepMetadata :: Type -> Type # Methods from :: ClarifyCheckStepMetadata -> Rep ClarifyCheckStepMetadata x # to :: Rep ClarifyCheckStepMetadata x -> ClarifyCheckStepMetadata #
Read ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods readsPrec :: Int -> ReadS ClarifyCheckStepMetadata # readList :: ReadS [ClarifyCheckStepMetadata] # readPrec :: ReadPrec ClarifyCheckStepMetadata # readListPrec :: ReadPrec [ClarifyCheckStepMetadata] #
Show ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods showsPrec :: Int -> ClarifyCheckStepMetadata -> ShowS # show :: ClarifyCheckStepMetadata -> String # showList :: [ClarifyCheckStepMetadata] -> ShowS #
NFData ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods rnf :: ClarifyCheckStepMetadata -> () #
Eq ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods (==) :: ClarifyCheckStepMetadata -> ClarifyCheckStepMetadata -> Bool # (/=) :: ClarifyCheckStepMetadata -> ClarifyCheckStepMetadata -> Bool #
Hashable ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata Methods hashWithSalt :: Int -> ClarifyCheckStepMetadata -> Int # hash :: ClarifyCheckStepMetadata -> Int #
type Rep ClarifyCheckStepMetadata Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyCheckStepMetadata type Rep ClarifyCheckStepMetadata = D1 ('MetaData "ClarifyCheckStepMetadata" "Amazonka.SageMaker.Types.ClarifyCheckStepMetadata" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ClarifyCheckStepMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "baselineUsedForDriftCheckConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "calculatedBaselineConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "checkJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "checkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registerNewBaseline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "skipCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "violationReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newClarifyCheckStepMetadata :: ClarifyCheckStepMetadata Source #

Create a value of ClarifyCheckStepMetadata 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:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_baselineUsedForDriftCheckConstraints - The Amazon S3 URI of baseline constraints file to be used for the drift check.

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

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

$sel:checkType:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_checkType - The type of the Clarify Check step

$sel:modelPackageGroupName:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_modelPackageGroupName - The model package group name.

$sel:registerNewBaseline:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_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.

$sel:skipCheck:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_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:ClarifyCheckStepMetadata', clarifyCheckStepMetadata_violationReport - The Amazon S3 URI of the violation report if violations are detected.

clarifyCheckStepMetadata_baselineUsedForDriftCheckConstraints :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

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

clarifyCheckStepMetadata_calculatedBaselineConstraints :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

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

clarifyCheckStepMetadata_checkJobArn :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

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

clarifyCheckStepMetadata_checkType :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The type of the Clarify Check step

clarifyCheckStepMetadata_modelPackageGroupName :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The model package group name.

clarifyCheckStepMetadata_registerNewBaseline :: Lens' ClarifyCheckStepMetadata (Maybe Bool) Source #

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.

clarifyCheckStepMetadata_skipCheck :: Lens' ClarifyCheckStepMetadata (Maybe Bool) Source #

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.

clarifyCheckStepMetadata_violationReport :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

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