| 1 | |||
| 2 | package Paws::ApiGateway::GetUsage; | ||
| 3 | use Moose; | ||
| 4 | has EndDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endDate', required => 1); | ||
| 5 | has KeyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'keyId'); | ||
| 6 | has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit'); | ||
| 7 | has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position'); | ||
| 8 | has StartDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startDate', required => 1); | ||
| 9 | has UsagePlanId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'usageplanId', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetUsage'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/usageplans/{usageplanId}/usage'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Usage'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ApiGateway::GetUsage - Arguments for method GetUsage on L<Paws::ApiGateway> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetUsage on the | ||
| 28 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 29 | as arguments to method GetUsage. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsage. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $apigateway = Paws->service('ApiGateway'); | ||
| 36 | my $Usage = $apigateway->GetUsage( | ||
| 37 | EndDate => 'MyString', | ||
| 38 | StartDate => 'MyString', | ||
| 39 | UsagePlanId => 'MyString', | ||
| 40 | KeyId => 'MyString', # OPTIONAL | ||
| 41 | Limit => 1, # OPTIONAL | ||
| 42 | Position => 'MyString', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $EndDate = $Usage->EndDate; | ||
| 47 | my $Items = $Usage->Items; | ||
| 48 | my $Position = $Usage->Position; | ||
| 49 | my $StartDate = $Usage->StartDate; | ||
| 50 | my $UsagePlanId = $Usage->UsagePlanId; | ||
| 51 | |||
| 52 | # Returns a L<Paws::ApiGateway::Usage> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetUsage> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> EndDate => Str | ||
| 61 | |||
| 62 | [Required] The ending date (e.g., 2016-12-31) of the usage data. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 KeyId => Str | ||
| 67 | |||
| 68 | The Id of the API key associated with the resultant usage data. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Limit => Int | ||
| 73 | |||
| 74 | The maximum number of returned results per page. The default value is | ||
| 75 | 25 and the maximum value is 500. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 Position => Str | ||
| 80 | |||
| 81 | The current pagination position in the paged result set. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> StartDate => Str | ||
| 86 | |||
| 87 | [Required] The starting date (e.g., 2016-01-01) of the usage data. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> UsagePlanId => Str | ||
| 92 | |||
| 93 | [Required] The Id of the usage plan associated with the usage data. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method GetUsage in L<Paws::ApiGateway> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |