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