| 1 | |||
| 2 | package Paws::IoT::SearchIndex; | ||
| 3 | use Moose; | ||
| 4 | has IndexName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'indexName'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | has QueryString => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'queryString', required => 1); | ||
| 8 | has QueryVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'queryVersion'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchIndex'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/indices/search'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::SearchIndexResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoT::SearchIndex - Arguments for method SearchIndex on L<Paws::IoT> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method SearchIndex on the | ||
| 27 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 28 | as arguments to method SearchIndex. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchIndex. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iot = Paws->service('IoT'); | ||
| 35 | my $SearchIndexResponse = $iot->SearchIndex( | ||
| 36 | QueryString => 'MyQueryString', | ||
| 37 | IndexName => 'MyIndexName', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | QueryVersion => 'MyQueryVersion', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $NextToken = $SearchIndexResponse->NextToken; | ||
| 45 | my $ThingGroups = $SearchIndexResponse->ThingGroups; | ||
| 46 | my $Things = $SearchIndexResponse->Things; | ||
| 47 | |||
| 48 | # Returns a L<Paws::IoT::SearchIndexResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/SearchIndex> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 IndexName => Str | ||
| 57 | |||
| 58 | The search index name. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 MaxResults => Int | ||
| 63 | |||
| 64 | The maximum number of results to return at one time. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 NextToken => Str | ||
| 69 | |||
| 70 | The token used to get the next set of results, or C<null> if there are | ||
| 71 | no additional results. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> QueryString => Str | ||
| 76 | |||
| 77 | The search query string. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 QueryVersion => Str | ||
| 82 | |||
| 83 | The query version. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method SearchIndex in L<Paws::IoT> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |