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