Class: Aws::SageMaker::Types::CreateCompilationJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compilation_job_name ⇒ String

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

Returns:

  • (String) 


5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_config ⇒ Types::InputConfig

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Returns:



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_package_version_arn ⇒ String

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ‘ModelPackageVersionArn` or an `InputConfig` object in the request syntax. The presence of both objects in the `CreateCompilationJob` request will return an exception.

Returns:

  • (String) 


5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OutputConfig

Provides information about the output location for the compiled model and the target device the model runs on.

Returns:



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :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.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the ‘iam:PassRole` permission. For more information, see [Amazon SageMaker Roles.]

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html

Returns:

  • (String) 


5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::StoppingCondition

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Returns:



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see [Tagging Amazon Web Services Resources].

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

Returns:



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::NeoVpcConfig

A [VpcConfig] object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see [Protect Compilation Jobs by Using an Amazon Virtual Private Cloud].

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html

Returns:



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5155

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :model_package_version_arn,
  :input_config,
  :output_config,
  :vpc_config,
  :stopping_condition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end