« blib/lib/Paws/LexModelsV2/ListBotVersionsResponse.pm
↑ Summary
blib/lib/Paws/LexModelsV2/ListBotsResponse.pm »
| 1 | |||
| 2 | package Paws::LexModelsV2::ListBots; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::LexModelsV2::BotFilter]', traits => ['NameInRequest'], request_name => 'filters'); | ||
| 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 SortBy => (is => 'ro', isa => 'Paws::LexModelsV2::BotSortBy', traits => ['NameInRequest'], request_name => 'sortBy'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListBots'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModelsV2::ListBotsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LexModelsV2::ListBots - Arguments for method ListBots on L<Paws::LexModelsV2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListBots on the | ||
| 26 | L<Amazon Lex Model Building V2|Paws::LexModelsV2> service. Use the attributes of this class | ||
| 27 | as arguments to method ListBots. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBots. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $models-v2-lex = Paws->service('LexModelsV2'); | ||
| 34 | my $ListBotsResponse = $models - v2 -lex->ListBots( | ||
| 35 | Filters => [ | ||
| 36 | { | ||
| 37 | Name => 'BotName', # values: BotName | ||
| 38 | Operator => 'CO', # values: CO, EQ | ||
| 39 | Values => [ | ||
| 40 | 'MyFilterValue', ... # min: 1, max: 100 | ||
| 41 | ], # min: 1, max: 1 | ||
| 42 | |||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | SortBy => { | ||
| 49 | Attribute => 'BotName', # values: BotName | ||
| 50 | Order => 'Ascending', # values: Ascending, Descending | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $BotSummaries = $ListBotsResponse->BotSummaries; | ||
| 57 | my $NextToken = $ListBotsResponse->NextToken; | ||
| 58 | |||
| 59 | # Returns a L<Paws::LexModelsV2::ListBotsResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/ListBots> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Filters => ArrayRef[L<Paws::LexModelsV2::BotFilter>] | ||
| 68 | |||
| 69 | Provides the specification of a filter used to limit the bots in the | ||
| 70 | response to only those that match the filter specification. You can | ||
| 71 | only specify one filter and one string to filter on. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MaxResults => Int | ||
| 76 | |||
| 77 | The maximum number of bots to return in each page of results. If there | ||
| 78 | are fewer results than the maximum page size, only the actual number of | ||
| 79 | results are returned. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | If the response from the C<ListBots> operation contains more results | ||
| 86 | than specified in the C<maxResults> parameter, a token is returned in | ||
| 87 | the response. Use that token in the C<nextToken> parameter to return | ||
| 88 | the next page of results. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 SortBy => L<Paws::LexModelsV2::BotSortBy> | ||
| 93 | |||
| 94 | Specifies sorting parameters for the list of bots. You can specify that | ||
| 95 | the list be sorted by bot name in ascending or descending order. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method ListBots in L<Paws::LexModelsV2> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |