« blib/lib/Paws/SageMaker/ListTrialComponentsResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/ListTrialsResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListTrials; | ||
| 3 | use Moose; | ||
| 4 | has CreatedAfter => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreatedBefore => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExperimentName => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 10 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 11 | has TrialComponentName => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTrials'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListTrialsResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SageMaker::ListTrials - Arguments for method ListTrials on L<Paws::SageMaker> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ListTrials on the | ||
| 29 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 30 | as arguments to method ListTrials. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTrials. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 37 | my $ListTrialsResponse = $api . sagemaker->ListTrials( | ||
| 38 | CreatedAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 39 | CreatedBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | ExperimentName => 'MyExperimentEntityName', # OPTIONAL | ||
| 41 | MaxResults => 1, # OPTIONAL | ||
| 42 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 43 | SortBy => 'Name', # OPTIONAL | ||
| 44 | SortOrder => 'Ascending', # OPTIONAL | ||
| 45 | TrialComponentName => 'MyExperimentEntityName', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $NextToken = $ListTrialsResponse->NextToken; | ||
| 50 | my $TrialSummaries = $ListTrialsResponse->TrialSummaries; | ||
| 51 | |||
| 52 | # Returns a L<Paws::SageMaker::ListTrialsResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListTrials> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 CreatedAfter => Str | ||
| 61 | |||
| 62 | A filter that returns only trials created after the specified time. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 CreatedBefore => Str | ||
| 67 | |||
| 68 | A filter that returns only trials created before the specified time. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 ExperimentName => Str | ||
| 73 | |||
| 74 | A filter that returns only trials that are part of the specified | ||
| 75 | experiment. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 MaxResults => Int | ||
| 80 | |||
| 81 | The maximum number of trials to return in the response. The default | ||
| 82 | value is 10. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 NextToken => Str | ||
| 87 | |||
| 88 | If the previous call to C<ListTrials> didn't return the full set of | ||
| 89 | trials, the call returns a token for getting the next set of trials. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 SortBy => Str | ||
| 94 | |||
| 95 | The property used to sort results. The default value is | ||
| 96 | C<CreationTime>. | ||
| 97 | |||
| 98 | Valid values are: C<"Name">, C<"CreationTime"> | ||
| 99 | |||
| 100 | =head2 SortOrder => Str | ||
| 101 | |||
| 102 | The sort order. The default value is C<Descending>. | ||
| 103 | |||
| 104 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 105 | |||
| 106 | =head2 TrialComponentName => Str | ||
| 107 | |||
| 108 | A filter that returns only trials that are associated with the | ||
| 109 | specified trial component. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method ListTrials in L<Paws::SageMaker> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |