« blib/lib/Paws/Kendra/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/Kendra/ListThesauriResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::ListThesauri; | ||
| 3 | use Moose; | ||
| 4 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListThesauri'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::ListThesauriResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kendra::ListThesauri - Arguments for method ListThesauri on L<Paws::Kendra> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListThesauri on the | ||
| 24 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 25 | as arguments to method ListThesauri. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListThesauri. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kendra = Paws->service('Kendra'); | ||
| 32 | my $ListThesauriResponse = $kendra->ListThesauri( | ||
| 33 | IndexId => 'MyIndexId', | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $NextToken = $ListThesauriResponse->NextToken; | ||
| 40 | my $ThesaurusSummaryItems = $ListThesauriResponse->ThesaurusSummaryItems; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Kendra::ListThesauriResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/ListThesauri> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> IndexId => Str | ||
| 51 | |||
| 52 | The identifier of the index associated with the thesaurus to list. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 MaxResults => Int | ||
| 57 | |||
| 58 | The maximum number of thesauri to return. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 NextToken => Str | ||
| 63 | |||
| 64 | If the previous response was incomplete (because there is more data to | ||
| 65 | retrieve), Amazon Kendra returns a pagination token in the response. | ||
| 66 | You can use this pagination token to retrieve the next set of thesauri | ||
| 67 | (C<ThesaurusSummaryItems>). | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, documenting arguments for method ListThesauri in L<Paws::Kendra> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |