| 1 | |||
| 2 | package Paws::ApiGateway::GetApiKeys; | ||
| 3 | use Moose; | ||
| 4 | has CustomerId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'customerId'); | ||
| 5 | has IncludeValues => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'includeValues'); | ||
| 6 | has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit'); | ||
| 7 | has NameQuery => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'name'); | ||
| 8 | has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetApiKeys'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apikeys'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::ApiKeys'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ApiGateway::GetApiKeys - Arguments for method GetApiKeys on L<Paws::ApiGateway> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetApiKeys on the | ||
| 27 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 28 | as arguments to method GetApiKeys. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetApiKeys. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $apigateway = Paws->service('ApiGateway'); | ||
| 35 | my $ApiKeys = $apigateway->GetApiKeys( | ||
| 36 | CustomerId => 'MyString', # OPTIONAL | ||
| 37 | IncludeValues => 1, # OPTIONAL | ||
| 38 | Limit => 1, # OPTIONAL | ||
| 39 | NameQuery => 'MyString', # OPTIONAL | ||
| 40 | Position => 'MyString', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Items = $ApiKeys->Items; | ||
| 45 | my $Position = $ApiKeys->Position; | ||
| 46 | my $Warnings = $ApiKeys->Warnings; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ApiGateway::ApiKeys> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetApiKeys> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CustomerId => Str | ||
| 57 | |||
| 58 | The identifier of a customer in AWS Marketplace or an external system, | ||
| 59 | such as a developer portal. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 IncludeValues => Bool | ||
| 64 | |||
| 65 | A boolean flag to specify whether (C<true>) or not (C<false>) the | ||
| 66 | result contains key values. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Limit => Int | ||
| 71 | |||
| 72 | The maximum number of returned results per page. The default value is | ||
| 73 | 25 and the maximum value is 500. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NameQuery => Str | ||
| 78 | |||
| 79 | The name of queried API keys. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Position => Str | ||
| 84 | |||
| 85 | The current pagination position in the paged result set. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method GetApiKeys in L<Paws::ApiGateway> | ||
| 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 |