« blib/lib/Paws/LexModels/GetBotVersionsResponse.pm
↑ Summary
blib/lib/Paws/LexModels/GetBotsResponse.pm »
| 1 | |||
| 2 | package Paws::LexModels::GetBots; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NameContains => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nameContains'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetBots'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModels::GetBotsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::LexModels::GetBots - Arguments for method GetBots on L<Paws::LexModels> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetBots on the | ||
| 25 | L<Amazon Lex Model Building Service|Paws::LexModels> service. Use the attributes of this class | ||
| 26 | as arguments to method GetBots. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetBots. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $models.lex = Paws->service('LexModels'); | ||
| 33 | # To get a list of bots | ||
| 34 | # This example shows how to get a list of all of the bots in your account. | ||
| 35 | my $GetBotsResponse = $models | ||
| 36 | . lex->GetBots( | ||
| 37 | 'MaxResults' => 5, | ||
| 38 | 'NextToken' => '' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $bots = $GetBotsResponse->bots; | ||
| 43 | |||
| 44 | # Returns a L<Paws::LexModels::GetBotsResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models.lex/GetBots> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 MaxResults => Int | ||
| 53 | |||
| 54 | The maximum number of bots to return in the response that the request | ||
| 55 | will return. The default is 10. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 NameContains => Str | ||
| 60 | |||
| 61 | Substring to match in bot names. A bot will be returned if any part of | ||
| 62 | its name matches the substring. For example, "xyz" matches both | ||
| 63 | "xyzabc" and "abcxyz." | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | A pagination token that fetches the next page of bots. If the response | ||
| 70 | to this call is truncated, Amazon Lex returns a pagination token in the | ||
| 71 | response. To fetch the next page of bots, specify the pagination token | ||
| 72 | in the next request. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method GetBots in L<Paws::LexModels> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |