amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Description

 
Synopsis

Documentation

data PipelineExecutionStepMetadata Source #

Metadata for a step execution.

See: newPipelineExecutionStepMetadata smart constructor.

Constructors

PipelineExecutionStepMetadata' 

Fields

  • autoMLJob :: Maybe AutoMLJobStepMetadata

    The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

  • callback :: Maybe CallbackStepMetadata

    The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

  • clarifyCheck :: Maybe ClarifyCheckStepMetadata

    Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

    • The type of the check conducted,
    • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
    • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
    • The model package group name provided.
    • The Amazon S3 URI of the violation report if violations detected.
    • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
    • The boolean flags indicating if the drift check is skipped.
    • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
  • condition :: Maybe ConditionStepMetadata

    The outcome of the condition evaluation that was run by this step execution.

  • emr :: Maybe EMRStepMetadata

    The configurations and outcomes of an Amazon EMR step execution.

  • fail :: Maybe FailStepMetadata

    The configurations and outcomes of a Fail step execution.

  • lambda :: Maybe LambdaStepMetadata

    The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

  • model :: Maybe ModelStepMetadata

    The Amazon Resource Name (ARN) of the model that was created by this step execution.

  • processingJob :: Maybe ProcessingJobStepMetadata

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

  • qualityCheck :: Maybe QualityCheckStepMetadata

    The configurations and outcomes of the check step execution. This includes:

    • The type of the check conducted.
    • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
    • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
    • The model package group name provided.
    • The Amazon S3 URI of the violation report if violations detected.
    • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
    • The Boolean flags indicating if the drift check is skipped.
    • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
  • registerModel :: Maybe RegisterModelStepMetadata

    The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

  • trainingJob :: Maybe TrainingJobStepMetadata

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

  • transformJob :: Maybe TransformJobStepMetadata

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

  • tuningJob :: Maybe TuningJobStepMetaData

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

Instances

Instances details
FromJSON PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Generic PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Associated Types

type Rep PipelineExecutionStepMetadata :: Type -> Type #

Read PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Show PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

NFData PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Eq PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

Hashable PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

type Rep PipelineExecutionStepMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.Types.PipelineExecutionStepMetadata

type Rep PipelineExecutionStepMetadata = D1 ('MetaData "PipelineExecutionStepMetadata" "Amazonka.SageMaker.Types.PipelineExecutionStepMetadata" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "PipelineExecutionStepMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoMLJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobStepMetadata)) :*: (S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallbackStepMetadata)) :*: S1 ('MetaSel ('Just "clarifyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClarifyCheckStepMetadata)))) :*: ((S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionStepMetadata)) :*: S1 ('MetaSel ('Just "emr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EMRStepMetadata))) :*: (S1 ('MetaSel ('Just "fail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailStepMetadata)) :*: S1 ('MetaSel ('Just "lambda") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaStepMetadata))))) :*: ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStepMetadata)) :*: (S1 ('MetaSel ('Just "processingJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingJobStepMetadata)) :*: S1 ('MetaSel ('Just "qualityCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QualityCheckStepMetadata)))) :*: ((S1 ('MetaSel ('Just "registerModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegisterModelStepMetadata)) :*: S1 ('MetaSel ('Just "trainingJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrainingJobStepMetadata))) :*: (S1 ('MetaSel ('Just "transformJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformJobStepMetadata)) :*: S1 ('MetaSel ('Just "tuningJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TuningJobStepMetaData)))))))

newPipelineExecutionStepMetadata :: PipelineExecutionStepMetadata Source #

Create a value of PipelineExecutionStepMetadata 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:autoMLJob:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_autoMLJob - The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

$sel:callback:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_callback - The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

$sel:clarifyCheck:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_clarifyCheck - Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,
  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
  • The model package group name provided.
  • The Amazon S3 URI of the violation report if violations detected.
  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
  • The boolean flags indicating if the drift check is skipped.
  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

$sel:condition:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_condition - The outcome of the condition evaluation that was run by this step execution.

$sel:emr:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_emr - The configurations and outcomes of an Amazon EMR step execution.

$sel:fail:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_fail - The configurations and outcomes of a Fail step execution.

$sel:lambda:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_lambda - The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

$sel:model:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_model - The Amazon Resource Name (ARN) of the model that was created by this step execution.

$sel:processingJob:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_processingJob - The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

$sel:qualityCheck:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_qualityCheck - The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.
  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
  • The model package group name provided.
  • The Amazon S3 URI of the violation report if violations detected.
  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
  • The Boolean flags indicating if the drift check is skipped.
  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

$sel:registerModel:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_registerModel - The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

$sel:trainingJob:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_trainingJob - The Amazon Resource Name (ARN) of the training job that was run by this step execution.

$sel:transformJob:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_transformJob - The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

$sel:tuningJob:PipelineExecutionStepMetadata', pipelineExecutionStepMetadata_tuningJob - The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

pipelineExecutionStepMetadata_autoMLJob :: Lens' PipelineExecutionStepMetadata (Maybe AutoMLJobStepMetadata) Source #

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

pipelineExecutionStepMetadata_callback :: Lens' PipelineExecutionStepMetadata (Maybe CallbackStepMetadata) Source #

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

pipelineExecutionStepMetadata_clarifyCheck :: Lens' PipelineExecutionStepMetadata (Maybe ClarifyCheckStepMetadata) Source #

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,
  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
  • The model package group name provided.
  • The Amazon S3 URI of the violation report if violations detected.
  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
  • The boolean flags indicating if the drift check is skipped.
  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

pipelineExecutionStepMetadata_condition :: Lens' PipelineExecutionStepMetadata (Maybe ConditionStepMetadata) Source #

The outcome of the condition evaluation that was run by this step execution.

pipelineExecutionStepMetadata_emr :: Lens' PipelineExecutionStepMetadata (Maybe EMRStepMetadata) Source #

The configurations and outcomes of an Amazon EMR step execution.

pipelineExecutionStepMetadata_fail :: Lens' PipelineExecutionStepMetadata (Maybe FailStepMetadata) Source #

The configurations and outcomes of a Fail step execution.

pipelineExecutionStepMetadata_lambda :: Lens' PipelineExecutionStepMetadata (Maybe LambdaStepMetadata) Source #

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

pipelineExecutionStepMetadata_model :: Lens' PipelineExecutionStepMetadata (Maybe ModelStepMetadata) Source #

The Amazon Resource Name (ARN) of the model that was created by this step execution.

pipelineExecutionStepMetadata_processingJob :: Lens' PipelineExecutionStepMetadata (Maybe ProcessingJobStepMetadata) Source #

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

pipelineExecutionStepMetadata_qualityCheck :: Lens' PipelineExecutionStepMetadata (Maybe QualityCheckStepMetadata) Source #

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.
  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.
  • The model package group name provided.
  • The Amazon S3 URI of the violation report if violations detected.
  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
  • The Boolean flags indicating if the drift check is skipped.
  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

pipelineExecutionStepMetadata_registerModel :: Lens' PipelineExecutionStepMetadata (Maybe RegisterModelStepMetadata) Source #

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

pipelineExecutionStepMetadata_trainingJob :: Lens' PipelineExecutionStepMetadata (Maybe TrainingJobStepMetadata) Source #

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

pipelineExecutionStepMetadata_transformJob :: Lens' PipelineExecutionStepMetadata (Maybe TransformJobStepMetadata) Source #

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

pipelineExecutionStepMetadata_tuningJob :: Lens' PipelineExecutionStepMetadata (Maybe TuningJobStepMetaData) Source #

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