You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#hyper_parameter_tuning_job_nameString

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

Returns:

  • (String)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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

#max_resultsInteger

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

Returns:

  • (Integer)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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

#next_tokenString

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)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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

#sort_byString

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)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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

#sort_orderString

The sort order for results. The default is Ascending.

Returns:

  • (String)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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

#status_equalsString

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

Returns:

  • (String)


8487
8488
8489
8490
8491
8492
8493
8494
8495
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8487

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