Class: Aws::SageMaker::Types::ClarifyCheckStepMetadata

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClarifyCheckStepMetadata

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #baseline_used_for_drift_check_constraints ⇒ String

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

• #calculated_baseline_constraints ⇒ String

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

• #check_job_arn ⇒ String

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

• #check_type ⇒ String

  The type of the Clarify Check step.

• #model_package_group_name ⇒ String

  The model package group name.

• #register_new_baseline ⇒ Boolean

  This flag indicates if a newly calculated baseline can be accessed through step properties ‘BaselineUsedForDriftCheckConstraints` and `BaselineUsedForDriftCheckStatistics`.

• #skip_check ⇒ Boolean

  This flag indicates if the drift check against the previous baseline will be skipped or not.

• #violation_report ⇒ String

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

Instance Attribute Details

#baseline_used_for_drift_check_constraints ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#calculated_baseline_constraints ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#check_job_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#check_type ⇒ String

The type of the Clarify Check step

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#model_package_group_name ⇒ String

The model package group name.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#register_new_baseline ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#skip_check ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end

#violation_report ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3836

class ClarifyCheckStepMetadata < Struct.new(
  :check_type,
  :baseline_used_for_drift_check_constraints,
  :calculated_baseline_constraints,
  :model_package_group_name,
  :violation_report,
  :check_job_arn,
  :skip_check,
  :register_new_baseline)
  SENSITIVE = []
  include Aws::Structure
end