| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGateway::QuotaSettings; | ||
| 3 | use Moose; | ||
| 4 | has Limit => (is => 'ro', isa => 'Int', request_name => 'limit', traits => ['NameInRequest']); | ||
| 5 | has Offset => (is => 'ro', isa => 'Int', request_name => 'offset', traits => ['NameInRequest']); | ||
| 6 | has Period => (is => 'ro', isa => 'Str', request_name => 'period', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ApiGateway::QuotaSettings | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ApiGateway::QuotaSettings object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Limit => $value, ..., Period => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::QuotaSettings object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Limit | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Quotas configured for a usage plan. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Limit => Int | ||
| 44 | |||
| 45 | The maximum number of requests that can be made in a given time period. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Offset => Int | ||
| 49 | |||
| 50 | The day that a time period starts. For example, with a time period of | ||
| 51 | C<WEEK>, an offset of C<0> starts on Sunday, and an offset of C<1> | ||
| 52 | starts on Monday. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Period => Str | ||
| 56 | |||
| 57 | The time period in which the limit applies. Valid values are "DAY", | ||
| 58 | "WEEK" or "MONTH". | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head1 SEE ALSO | ||
| 63 | |||
| 64 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGateway> | ||
| 65 | |||
| 66 | =head1 BUGS and CONTRIBUTIONS | ||
| 67 | |||
| 68 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 69 | |||
| 70 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 71 | |||
| 72 | =cut | ||
| 73 |