Class: Aws::SageMaker::Types::ListTrainingJobsForHyperParameterTuningJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ListTrainingJobsForHyperParameterTuningJobRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ListTrainingJobsForHyperParameterTuningJobRequest data as a hash:

{
  hyper_parameter_tuning_job_name: "HyperParameterTuningJobName", # required
  next_token: "NextToken",
  max_results: 1,
  status_equals: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped
  sort_by: "Name", # accepts Name, CreationTime, Status, FinalObjectiveMetricValue
  sort_order: "Ascending", # accepts Ascending, Descending
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #hyper_parameter_tuning_job_name ⇒ String

  The name of the tuning job whose training jobs you want to list.

• #max_results ⇒ Integer

  The maximum number of training jobs to return.

• #next_token ⇒ String

  If the result of the previous ‘ListTrainingJobsForHyperParameterTuningJob` request was truncated, the response includes a `NextToken`.

• #sort_by ⇒ String

  The field to sort results by.

• #sort_order ⇒ String

  The sort order for results.

• #status_equals ⇒ String

  A filter that returns only training jobs with the specified status.

Instance Attribute Details

#hyper_parameter_tuning_job_name ⇒ String

The name of the tuning job whose training jobs you want to list.

Returns:

• (String)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of training jobs to return. The default value is 10.

Returns:

• (Integer)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#next_token ⇒ String

If the result of the previous ‘ListTrainingJobsForHyperParameterTuningJob` request was truncated, the response includes a `NextToken`. To retrieve the next set of training jobs, use the token in the next request.

Returns:

• (String)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#sort_by ⇒ String

The field to sort results by. The default is ‘Name`.

If the value of this field is ‘FinalObjectiveMetricValue`, any training jobs that did not return an objective metric are not listed.

Returns:

• (String)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#sort_order ⇒ String

The sort order for results. The default is ‘Ascending`.

Returns:

• (String)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#status_equals ⇒ String

A filter that returns only training jobs with the specified status.

Returns:

• (String)

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

class ListTrainingJobsForHyperParameterTuningJobRequest < Struct.new(
  :hyper_parameter_tuning_job_name,
  :next_token,
  :max_results,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end