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