AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListTrainingJobsForHyperParameterTuningJobRequest as input to an Aws::Client method, you can use a vanilla 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)

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

#max_resultsInteger

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

Returns:

  • (Integer)

    The maximum number of training jobs to return.

#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)

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

#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.

Possible values:

  • Name
  • CreationTime
  • Status
  • FinalObjectiveMetricValue

Returns:

  • (String)

    The field to sort results by.

#sort_orderString

The sort order for results. The default is Ascending.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String)

    The sort order for results.

#status_equalsString

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

Possible values:

  • InProgress
  • Completed
  • Failed
  • Stopping
  • Stopped

Returns:

  • (String)

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