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