Class: Aws::SageMaker::Types::CreateInferenceRecommendationsJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateInferenceRecommendationsJobRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #input_config ⇒ Types::RecommendationJobInputConfig

  Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

• #job_description ⇒ String

  Description of the recommendation job.

• #job_name ⇒ String

  A name for the recommendation job.

• #job_type ⇒ String

  Defines the type of recommendation job.

• #output_config ⇒ Types::RecommendationJobOutputConfig

  Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

• #role_arn ⇒ String

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

• #stopping_conditions ⇒ Types::RecommendationJobStoppingConditions

  A set of conditions for stopping a recommendation job.

• #tags ⇒ Array<Types::Tag>

  The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

Instance Attribute Details

#input_config ⇒ Types::RecommendationJobInputConfig

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Returns:

• (Types::RecommendationJobInputConfig)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_description ⇒ String

Description of the recommendation job.

Returns:

• (String)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

Returns:

• (String)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

Defines the type of recommendation job. Specify ‘Default` to initiate an instance recommendation and `Advanced` to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (`DEFAULT`) job.

Returns:

• (String)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::RecommendationJobOutputConfig

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

Returns:

• (Types::RecommendationJobOutputConfig)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_conditions ⇒ Types::RecommendationJobStoppingConditions

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

Returns:

• (Types::RecommendationJobStoppingConditions)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see [Tagging Amazon Web Services Resources] in the Amazon Web Services General Reference.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Array<Types::Tag>)

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

class CreateInferenceRecommendationsJobRequest < Struct.new(
  :job_name,
  :job_type,
  :role_arn,
  :input_config,
  :job_description,
  :stopping_conditions,
  :output_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end