« blib/lib/Paws/SageMaker/ListTrainingJobs.pm
↑ Summary
blib/lib/Paws/SageMaker/ListTrainingJobsForHyperParameterTuningJobResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJob; | ||
| 3 | use Moose; | ||
| 4 | has HyperParameterTuningJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 8 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 9 | has StatusEquals => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTrainingJobsForHyperParameterTuningJob'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJobResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJob - Arguments for method ListTrainingJobsForHyperParameterTuningJob on L<Paws::SageMaker> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListTrainingJobsForHyperParameterTuningJob on the | ||
| 27 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 28 | as arguments to method ListTrainingJobsForHyperParameterTuningJob. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTrainingJobsForHyperParameterTuningJob. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 35 | my $ListTrainingJobsForHyperParameterTuningJobResponse = | ||
| 36 | $api . sagemaker->ListTrainingJobsForHyperParameterTuningJob( | ||
| 37 | HyperParameterTuningJobName => 'MyHyperParameterTuningJobName', | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | SortBy => 'Name', # OPTIONAL | ||
| 41 | SortOrder => 'Ascending', # OPTIONAL | ||
| 42 | StatusEquals => 'InProgress', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $NextToken = | ||
| 47 | $ListTrainingJobsForHyperParameterTuningJobResponse->NextToken; | ||
| 48 | my $TrainingJobSummaries = | ||
| 49 | $ListTrainingJobsForHyperParameterTuningJobResponse->TrainingJobSummaries; | ||
| 50 | |||
| 51 | # Returns a L<Paws::SageMaker::ListTrainingJobsForHyperParameterTuningJobResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListTrainingJobsForHyperParameterTuningJob> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> HyperParameterTuningJobName => Str | ||
| 60 | |||
| 61 | The name of the tuning job whose training jobs you want to list. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 MaxResults => Int | ||
| 66 | |||
| 67 | The maximum number of training jobs to return. The default value is 10. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 NextToken => Str | ||
| 72 | |||
| 73 | If the result of the previous | ||
| 74 | C<ListTrainingJobsForHyperParameterTuningJob> request was truncated, | ||
| 75 | the response includes a C<NextToken>. To retrieve the next set of | ||
| 76 | training jobs, use the token in the next request. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 SortBy => Str | ||
| 81 | |||
| 82 | The field to sort results by. The default is C<Name>. | ||
| 83 | |||
| 84 | If the value of this field is C<FinalObjectiveMetricValue>, any | ||
| 85 | training jobs that did not return an objective metric are not listed. | ||
| 86 | |||
| 87 | Valid values are: C<"Name">, C<"CreationTime">, C<"Status">, C<"FinalObjectiveMetricValue"> | ||
| 88 | |||
| 89 | =head2 SortOrder => Str | ||
| 90 | |||
| 91 | The sort order for results. The default is C<Ascending>. | ||
| 92 | |||
| 93 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 94 | |||
| 95 | =head2 StatusEquals => Str | ||
| 96 | |||
| 97 | A filter that returns only training jobs with the specified status. | ||
| 98 | |||
| 99 | Valid values are: C<"InProgress">, C<"Completed">, C<"Failed">, C<"Stopping">, C<"Stopped"> | ||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method ListTrainingJobsForHyperParameterTuningJob in L<Paws::SageMaker> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |