| 1 | |||
| 2 | package Paws::SageMaker::Search; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has Resource => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has SearchExpression => (is => 'ro', isa => 'Paws::SageMaker::SearchExpression'); | ||
| 8 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 9 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'Search'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::SearchResponse'); | ||
| 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::Search - Arguments for method Search on L<Paws::SageMaker> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method Search on the | ||
| 27 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 28 | as arguments to method Search. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Search. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 35 | my $SearchResponse = $api . sagemaker->Search( | ||
| 36 | Resource => 'TrainingJob', | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | SearchExpression => { | ||
| 40 | Filters => [ | ||
| 41 | { | ||
| 42 | Name => 'MyResourcePropertyName', # min: 1, max: 255 | ||
| 43 | Operator => 'Equals' | ||
| 44 | , # values: Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains, Exists, NotExists, In; OPTIONAL | ||
| 45 | Value => 'MyFilterValue', # min: 1, max: 1024; OPTIONAL | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # min: 1, max: 20; OPTIONAL | ||
| 49 | NestedFilters => [ | ||
| 50 | { | ||
| 51 | Filters => [ | ||
| 52 | { | ||
| 53 | Name => 'MyResourcePropertyName', # min: 1, max: 255 | ||
| 54 | Operator => 'Equals' | ||
| 55 | , # values: Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains, Exists, NotExists, In; OPTIONAL | ||
| 56 | Value => 'MyFilterValue', # min: 1, max: 1024; OPTIONAL | ||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], # min: 1, max: 20; OPTIONAL | ||
| 60 | NestedPropertyName => 'MyResourcePropertyName', # min: 1, max: 255 | ||
| 61 | |||
| 62 | }, | ||
| 63 | ... | ||
| 64 | ], # min: 1, max: 20; OPTIONAL | ||
| 65 | Operator => 'And', # values: And, Or; OPTIONAL | ||
| 66 | SubExpressions => [ <SearchExpression>, ... ] | ||
| 67 | , # min: 1, max: 20; OPTIONAL | ||
| 68 | }, # OPTIONAL | ||
| 69 | SortBy => 'MyResourcePropertyName', # OPTIONAL | ||
| 70 | SortOrder => 'Ascending', # OPTIONAL | ||
| 71 | ); | ||
| 72 | |||
| 73 | # Results: | ||
| 74 | my $NextToken = $SearchResponse->NextToken; | ||
| 75 | my $Results = $SearchResponse->Results; | ||
| 76 | |||
| 77 | # Returns a L<Paws::SageMaker::SearchResponse> object. | ||
| 78 | |||
| 79 | 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. | ||
| 80 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/Search> | ||
| 81 | |||
| 82 | =head1 ATTRIBUTES | ||
| 83 | |||
| 84 | |||
| 85 | =head2 MaxResults => Int | ||
| 86 | |||
| 87 | The maximum number of results to return. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 NextToken => Str | ||
| 92 | |||
| 93 | If more than C<MaxResults> resources match the specified | ||
| 94 | C<SearchExpression>, the response includes a C<NextToken>. The | ||
| 95 | C<NextToken> can be passed to the next C<SearchRequest> to continue | ||
| 96 | retrieving results. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> Resource => Str | ||
| 101 | |||
| 102 | The name of the Amazon SageMaker resource to search for. | ||
| 103 | |||
| 104 | Valid values are: C<"TrainingJob">, C<"Experiment">, C<"ExperimentTrial">, C<"ExperimentTrialComponent">, C<"Endpoint">, C<"ModelPackage">, C<"ModelPackageGroup">, C<"Pipeline">, C<"PipelineExecution">, C<"FeatureGroup"> | ||
| 105 | |||
| 106 | =head2 SearchExpression => L<Paws::SageMaker::SearchExpression> | ||
| 107 | |||
| 108 | A Boolean conditional statement. Resources must satisfy this condition | ||
| 109 | to be included in search results. You must provide at least one | ||
| 110 | subexpression, filter, or nested filter. The maximum number of | ||
| 111 | recursive C<SubExpressions>, C<NestedFilters>, and C<Filters> that can | ||
| 112 | be included in a C<SearchExpression> object is 50. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 SortBy => Str | ||
| 117 | |||
| 118 | The name of the resource property used to sort the C<SearchResults>. | ||
| 119 | The default is C<LastModifiedTime>. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 SortOrder => Str | ||
| 124 | |||
| 125 | How C<SearchResults> are ordered. Valid values are C<Ascending> or | ||
| 126 | C<Descending>. The default is C<Descending>. | ||
| 127 | |||
| 128 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method Search in L<Paws::SageMaker> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |