/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGateway::GetUsage

NAME

Paws::ApiGateway::GetUsage - Arguments for method GetUsage on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method GetUsage on the Amazon API Gateway service. Use the attributes of this class as arguments to method GetUsage.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsage.

SYNOPSIS

my $apigateway = Paws->service('ApiGateway');
my $Usage = $apigateway->GetUsage(
  EndDate     => 'MyString',
  StartDate   => 'MyString',
  UsagePlanId => 'MyString',
  KeyId       => 'MyString',    # OPTIONAL
  Limit       => 1,             # OPTIONAL
  Position    => 'MyString',    # OPTIONAL
);

# Results:
my $EndDate     = $Usage->EndDate;
my $Items       = $Usage->Items;
my $Position    = $Usage->Position;
my $StartDate   = $Usage->StartDate;
my $UsagePlanId = $Usage->UsagePlanId;

# Returns a L<Paws::ApiGateway::Usage> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetUsage

ATTRIBUTES

REQUIRED EndDate => Str

[Required] The ending date (e.g., 2016-12-31) of the usage data.

KeyId => Str

The Id of the API key associated with the resultant usage data.

Limit => Int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Position => Str

The current pagination position in the paged result set.

REQUIRED StartDate => Str

[Required] The starting date (e.g., 2016-01-01) of the usage data.

REQUIRED UsagePlanId => Str

[Required] The Id of the usage plan associated with the usage data.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetUsage in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues