« blib/lib/Paws/SageMaker/ListAutoMLJobsResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/ListCandidatesForAutoMLJobResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListCandidatesForAutoMLJob; | ||
| 3 | use Moose; | ||
| 4 | has AutoMLJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CandidateNameEquals => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 9 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 10 | has StatusEquals => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListCandidatesForAutoMLJob'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListCandidatesForAutoMLJobResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SageMaker::ListCandidatesForAutoMLJob - Arguments for method ListCandidatesForAutoMLJob on L<Paws::SageMaker> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListCandidatesForAutoMLJob on the | ||
| 28 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 29 | as arguments to method ListCandidatesForAutoMLJob. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListCandidatesForAutoMLJob. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 36 | my $ListCandidatesForAutoMLJobResponse = | ||
| 37 | $api . sagemaker->ListCandidatesForAutoMLJob( | ||
| 38 | AutoMLJobName => 'MyAutoMLJobName', | ||
| 39 | CandidateNameEquals => 'MyCandidateName', # OPTIONAL | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | SortBy => 'CreationTime', # OPTIONAL | ||
| 43 | SortOrder => 'Ascending', # OPTIONAL | ||
| 44 | StatusEquals => 'Completed', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $Candidates = $ListCandidatesForAutoMLJobResponse->Candidates; | ||
| 49 | my $NextToken = $ListCandidatesForAutoMLJobResponse->NextToken; | ||
| 50 | |||
| 51 | # Returns a L<Paws::SageMaker::ListCandidatesForAutoMLJobResponse> 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/ListCandidatesForAutoMLJob> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> AutoMLJobName => Str | ||
| 60 | |||
| 61 | List the candidates created for the job by providing the job's name. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 CandidateNameEquals => Str | ||
| 66 | |||
| 67 | List the candidates for the job and filter by candidate name. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxResults => Int | ||
| 72 | |||
| 73 | List the job's candidates up to a specified limit. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | If the previous response was truncated, you receive this token. Use it | ||
| 80 | in your next request to receive the next set of results. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 SortBy => Str | ||
| 85 | |||
| 86 | The parameter by which to sort the results. The default is | ||
| 87 | C<Descending>. | ||
| 88 | |||
| 89 | Valid values are: C<"CreationTime">, C<"Status">, C<"FinalObjectiveMetricValue"> | ||
| 90 | |||
| 91 | =head2 SortOrder => Str | ||
| 92 | |||
| 93 | The sort order for the results. The default is C<Ascending>. | ||
| 94 | |||
| 95 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 96 | |||
| 97 | =head2 StatusEquals => Str | ||
| 98 | |||
| 99 | List the candidates for the job and filter by status. | ||
| 100 | |||
| 101 | Valid values are: C<"Completed">, C<"InProgress">, C<"Failed">, C<"Stopped">, C<"Stopping"> | ||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, documenting arguments for method ListCandidatesForAutoMLJob in L<Paws::SageMaker> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |