Class: Aws::SageMaker::Types::DescribeTrainingPlanResponse

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::DescribeTrainingPlanResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #available_instance_count ⇒ Integer

  The number of instances currently available for use in this training plan.

• #currency_code ⇒ String

  The currency code for the upfront fee (e.g., USD).

• #duration_hours ⇒ Integer

  The number of whole hours in the total duration for this training plan.

• #duration_minutes ⇒ Integer

  The additional minutes beyond whole hours in the total duration for this training plan.

• #end_time ⇒ Time

  The end time of the training plan.

• #in_use_instance_count ⇒ Integer

  The number of instances currently in use from this training plan.

• #reserved_capacity_summaries ⇒ Array<Types::ReservedCapacitySummary>

  The list of Reserved Capacity providing the underlying compute resources of the plan.

• #start_time ⇒ Time

  The start time of the training plan.

• #status ⇒ String

  The current status of the training plan (e.g., Pending, Active, Expired).

• #status_message ⇒ String

  A message providing additional information about the current status of the training plan.

• #target_resources ⇒ Array<String>

  The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

• #total_instance_count ⇒ Integer

  The total number of instances reserved in this training plan.

• #training_plan_arn ⇒ String

  The Amazon Resource Name (ARN); of the training plan.

• #training_plan_name ⇒ String

  The name of the training plan.

• #upfront_fee ⇒ String

  The upfront fee for the training plan.

Instance Attribute Details

#available_instance_count ⇒ Integer

The number of instances currently available for use in this training plan.

Returns:

• (Integer)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#currency_code ⇒ String

The currency code for the upfront fee (e.g., USD).

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#duration_hours ⇒ Integer

The number of whole hours in the total duration for this training plan.

Returns:

• (Integer)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#duration_minutes ⇒ Integer

The additional minutes beyond whole hours in the total duration for this training plan.

Returns:

• (Integer)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time of the training plan.

Returns:

• (Time)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#in_use_instance_count ⇒ Integer

The number of instances currently in use from this training plan.

Returns:

• (Integer)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_capacity_summaries ⇒ Array<Types::ReservedCapacitySummary>

The list of Reserved Capacity providing the underlying compute resources of the plan.

Returns:

• (Array<Types::ReservedCapacitySummary>)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the training plan.

Returns:

• (Time)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the ‘Status` attribute within the ` TrainingPlanSummary ` object.

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A message providing additional information about the current status of the training plan.

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#target_resources ⇒ Array<String>

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

Training plans are specific to their target resource.

• A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

• A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster’s instance group.

Returns:

• (Array<String>)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#total_instance_count ⇒ Integer

The total number of instances reserved in this training plan.

Returns:

• (Integer)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_arn ⇒ String

The Amazon Resource Name (ARN); of the training plan.

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_name ⇒ String

The name of the training plan.

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#upfront_fee ⇒ String

The upfront fee for the training plan.

Returns:

• (String)

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

class DescribeTrainingPlanResponse < Struct.new(
  :training_plan_arn,
  :training_plan_name,
  :status,
  :status_message,
  :duration_hours,
  :duration_minutes,
  :start_time,
  :end_time,
  :upfront_fee,
  :currency_code,
  :total_instance_count,
  :available_instance_count,
  :in_use_instance_count,
  :target_resources,
  :reserved_capacity_summaries)
  SENSITIVE = []
  include Aws::Structure
end