Amazonka.SageMaker.Types.QualityCheckStepMetadata

Documentation

data QualityCheckStepMetadata

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.

Constructors

QualityCheckStepMetadata'

Fields

• baselineUsedForDriftCheckConstraints :: Maybe Text

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

• baselineUsedForDriftCheckStatistics :: Maybe Text

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

• calculatedBaselineConstraints :: Maybe Text

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

• calculatedBaselineStatistics :: Maybe Text

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

• checkJobArn :: Maybe Text

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

• checkType :: Maybe Text

  The type of the Quality 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 and BaselineUsedForDriftCheckStatistics properties.

• 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 violation report if violations are detected.

Instances

FromJSON QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

parseJSON :: Value -> Parser QualityCheckStepMetadata

parseJSONList :: Value -> Parser [QualityCheckStepMetadata]

Generic QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Associated Types

type Rep QualityCheckStepMetadata :: Type -> Type

Methods

from :: QualityCheckStepMetadata -> Rep QualityCheckStepMetadata x

to :: Rep QualityCheckStepMetadata x -> QualityCheckStepMetadata

Read QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

readsPrec :: Int -> ReadS QualityCheckStepMetadata

readList :: ReadS [QualityCheckStepMetadata]

readPrec :: ReadPrec QualityCheckStepMetadata

readListPrec :: ReadPrec [QualityCheckStepMetadata]

Show QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

showsPrec :: Int -> QualityCheckStepMetadata -> ShowS

show :: QualityCheckStepMetadata -> String

showList :: [QualityCheckStepMetadata] -> ShowS

NFData QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

rnf :: QualityCheckStepMetadata -> ()

Eq QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

(==) :: QualityCheckStepMetadata -> QualityCheckStepMetadata -> Bool

(/=) :: QualityCheckStepMetadata -> QualityCheckStepMetadata -> Bool

Hashable QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

Methods

hashWithSalt :: Int -> QualityCheckStepMetadata -> Int

hash :: QualityCheckStepMetadata -> Int

type Rep QualityCheckStepMetadata

Defined in Amazonka.SageMaker.Types.QualityCheckStepMetadata

type Rep QualityCheckStepMetadata = D1 ('MetaData "QualityCheckStepMetadata" "Amazonka.SageMaker.Types.QualityCheckStepMetadata" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "QualityCheckStepMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "baselineUsedForDriftCheckConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "baselineUsedForDriftCheckStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "calculatedBaselineConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "calculatedBaselineStatistics") '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)))))))

newQualityCheckStepMetadata :: QualityCheckStepMetadata

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.

qualityCheckStepMetadata_baselineUsedForDriftCheckConstraints :: Lens' QualityCheckStepMetadata (Maybe Text)

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

qualityCheckStepMetadata_baselineUsedForDriftCheckStatistics :: Lens' QualityCheckStepMetadata (Maybe Text)

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

qualityCheckStepMetadata_calculatedBaselineConstraints :: Lens' QualityCheckStepMetadata (Maybe Text)

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

qualityCheckStepMetadata_calculatedBaselineStatistics :: Lens' QualityCheckStepMetadata (Maybe Text)

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

qualityCheckStepMetadata_checkJobArn :: Lens' QualityCheckStepMetadata (Maybe Text)

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

qualityCheckStepMetadata_checkType :: Lens' QualityCheckStepMetadata (Maybe Text)

The type of the Quality check step.

qualityCheckStepMetadata_modelPackageGroupName :: Lens' QualityCheckStepMetadata (Maybe Text)

The model package group name.

qualityCheckStepMetadata_registerNewBaseline :: Lens' QualityCheckStepMetadata (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 and BaselineUsedForDriftCheckStatistics properties.

qualityCheckStepMetadata_skipCheck :: Lens' QualityCheckStepMetadata (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.

qualityCheckStepMetadata_violationReport :: Lens' QualityCheckStepMetadata (Maybe Text)

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