Class: Aws::SageMaker::Types::DescribeOptimizationJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::DescribeOptimizationJobResponse

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The time when you created the optimization job.

• #deployment_instance_type ⇒ String

  The type of instance that hosts the optimized model that you create with the optimization job.

• #failure_reason ⇒ String

  If the optimization job status is FAILED, the reason for the failure.

• #last_modified_time ⇒ Time

  The time when the optimization job was last updated.

• #max_instance_count ⇒ Integer

  The maximum number of instances to use for the optimization job.

• #model_source ⇒ Types::OptimizationJobModelSource

  The location of the source model to optimize with an optimization job.

• #optimization_configs ⇒ Array<Types::OptimizationConfig>

  Settings for each of the optimization techniques that the job applies.

• #optimization_end_time ⇒ Time

  The time when the optimization job finished processing.

• #optimization_environment ⇒ Hash<String,String>

  The environment variables to set in the model container.

• #optimization_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the optimization job.

• #optimization_job_name ⇒ String

  The name that you assigned to the optimization job.

• #optimization_job_status ⇒ String

  The current status of the optimization job.

• #optimization_output ⇒ Types::OptimizationOutput

  Output values produced by an optimization job.

• #optimization_start_time ⇒ Time

  The time when the optimization job started.

• #output_config ⇒ Types::OptimizationJobOutputConfig

  Details for where to store the optimized model that you create with the optimization job.

• #role_arn ⇒ String

  The ARN of the IAM role that you assigned to the optimization job.

• #stopping_condition ⇒ Types::StoppingCondition

  Specifies a limit to how long a job can run.

• #vpc_config ⇒ Types::OptimizationVpcConfig

  A VPC in Amazon VPC that your optimized model has access to.

Instance Attribute Details

#creation_time ⇒ Time

The time when you created the optimization job.

Returns:

• (Time)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_instance_type ⇒ String

The type of instance that hosts the optimized model that you create with the optimization job.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If the optimization job status is FAILED, the reason for the failure.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The time when the optimization job was last updated.

Returns:

• (Time)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_instance_count ⇒ Integer

The maximum number of instances to use for the optimization job.

Returns:

• (Integer)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_source ⇒ Types::OptimizationJobModelSource

The location of the source model to optimize with an optimization job.

Returns:

• (Types::OptimizationJobModelSource)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_configs ⇒ Array<Types::OptimizationConfig>

Settings for each of the optimization techniques that the job applies.

Returns:

• (Array<Types::OptimizationConfig>)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_end_time ⇒ Time

The time when the optimization job finished processing.

Returns:

• (Time)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_environment ⇒ Hash<String,String>

The environment variables to set in the model container.

Returns:

• (Hash<String,String>)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_job_arn ⇒ String

The Amazon Resource Name (ARN) of the optimization job.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_job_name ⇒ String

The name that you assigned to the optimization job.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_job_status ⇒ String

The current status of the optimization job.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_output ⇒ Types::OptimizationOutput

Output values produced by an optimization job.

Returns:

• (Types::OptimizationOutput)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_start_time ⇒ Time

The time when the optimization job started.

Returns:

• (Time)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OptimizationJobOutputConfig

Details for where to store the optimized model that you create with the optimization job.

Returns:

• (Types::OptimizationJobOutputConfig)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that you assigned to the optimization job.

Returns:

• (String)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::StoppingCondition

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

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

Returns:

• (Types::StoppingCondition)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::OptimizationVpcConfig

A VPC in Amazon VPC that your optimized model has access to.

Returns:

• (Types::OptimizationVpcConfig)

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

class DescribeOptimizationJobResponse < Struct.new(
  :optimization_job_arn,
  :optimization_job_status,
  :optimization_start_time,
  :optimization_end_time,
  :creation_time,
  :last_modified_time,
  :failure_reason,
  :optimization_job_name,
  :model_source,
  :optimization_environment,
  :deployment_instance_type,
  :max_instance_count,
  :optimization_configs,
  :output_config,
  :optimization_output,
  :role_arn,
  :stopping_condition,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end