NAME

Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJob - Arguments for method ListTrainingJobsForHyperParameterTuningJob on Paws::SageMaker

DESCRIPTION

This class represents the parameters used for calling the method ListTrainingJobsForHyperParameterTuningJob on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method ListTrainingJobsForHyperParameterTuningJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTrainingJobsForHyperParameterTuningJob.

SYNOPSIS

my $api.sagemaker = Paws->service('SageMaker');
my $ListTrainingJobsForHyperParameterTuningJobResponse =
  $api . sagemaker->ListTrainingJobsForHyperParameterTuningJob(
  HyperParameterTuningJobName => 'MyHyperParameterTuningJobName',
  MaxResults                  => 1,                               # OPTIONAL
  NextToken                   => 'MyNextToken',                   # OPTIONAL
  SortBy                      => 'Name',                          # OPTIONAL
  SortOrder                   => 'Ascending',                     # OPTIONAL
  StatusEquals                => 'InProgress',                    # OPTIONAL
  );

# Results:
my $NextToken =
  $ListTrainingJobsForHyperParameterTuningJobResponse->NextToken;
my $TrainingJobSummaries =
  $ListTrainingJobsForHyperParameterTuningJobResponse->TrainingJobSummaries;

# Returns a Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJobResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListTrainingJobsForHyperParameterTuningJob

ATTRIBUTES

REQUIRED HyperParameterTuningJobName => Str

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

MaxResults => Int

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

NextToken => Str

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.

SortBy => Str

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.

Valid values are: "Name", "CreationTime", "Status", "FinalObjectiveMetricValue"

SortOrder => Str

The sort order for results. The default is Ascending.

Valid values are: "Ascending", "Descending"

StatusEquals => Str

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

Valid values are: "InProgress", "Completed", "Failed", "Stopping", "Stopped"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListTrainingJobsForHyperParameterTuningJob in Paws::SageMaker

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues