Class: Aws::SageMaker::Types::CreateModelExplainabilityJobDefinitionRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateModelExplainabilityJobDefinitionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_definition_name ⇒ String

  The name of the model explainability job definition.

• #job_resources ⇒ Types::MonitoringResources

  Identifies the resources to deploy for a monitoring job.

• #model_explainability_app_specification ⇒ Types::ModelExplainabilityAppSpecification

  Configures the model explainability job to run a specified Docker container image.

• #model_explainability_baseline_config ⇒ Types::ModelExplainabilityBaselineConfig

  The baseline configuration for a model explainability job.

• #model_explainability_job_input ⇒ Types::ModelExplainabilityJobInput

  Inputs for the model explainability job.

• #model_explainability_job_output_config ⇒ Types::MonitoringOutputConfig

  The output configuration for monitoring jobs.

• #network_config ⇒ Types::MonitoringNetworkConfig

  Networking options for a model explainability job.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

• #stopping_condition ⇒ Types::MonitoringStoppingCondition

  A time limit for how long the monitoring job is allowed to run before stopping.

• #tags ⇒ Array<Types::Tag>

  (Optional) An array of key-value pairs.

Instance Attribute Details

#job_definition_name ⇒ String

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Returns:

• (String)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_resources ⇒ Types::MonitoringResources

Identifies the resources to deploy for a monitoring job.

Returns:

• (Types::MonitoringResources)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_explainability_app_specification ⇒ Types::ModelExplainabilityAppSpecification

Configures the model explainability job to run a specified Docker container image.

Returns:

• (Types::ModelExplainabilityAppSpecification)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_explainability_baseline_config ⇒ Types::ModelExplainabilityBaselineConfig

The baseline configuration for a model explainability job.

Returns:

• (Types::ModelExplainabilityBaselineConfig)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_explainability_job_input ⇒ Types::ModelExplainabilityJobInput

Inputs for the model explainability job.

Returns:

• (Types::ModelExplainabilityJobInput)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_explainability_job_output_config ⇒ Types::MonitoringOutputConfig

The output configuration for monitoring jobs.

Returns:

• (Types::MonitoringOutputConfig)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_config ⇒ Types::MonitoringNetworkConfig

Networking options for a model explainability job.

Returns:

• (Types::MonitoringNetworkConfig)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

Returns:

• (String)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::MonitoringStoppingCondition

A time limit for how long the monitoring job is allowed to run before stopping.

Returns:

• (Types::MonitoringStoppingCondition)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

(Optional) An array of key-value pairs. For more information, see [ Using Cost Allocation Tags] in the *Amazon Web Services Billing and Cost Management User Guide*.

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL

Returns:

• (Array<Types::Tag>)

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

class CreateModelExplainabilityJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :model_explainability_baseline_config,
  :model_explainability_app_specification,
  :model_explainability_job_input,
  :model_explainability_job_output_config,
  :job_resources,
  :network_config,
  :role_arn,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end