You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::GetUsageRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetUsageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  usage_plan_id: "String", # required
  key_id: "String",
  start_date: "String", # required
  end_date: "String", # required
  position: "String",
  limit: 1,
}

The GET request to get the usage data of a usage plan in a specified time interval.

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateString

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

Returns:

  • (String)

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

#key_idString

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

Returns:

  • (String)

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

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)

    The maximum number of returned results per page.

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)

    The current pagination position in the paged result set.

#start_dateString

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

Returns:

  • (String)

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

#usage_plan_idString

The Id of the usage plan associated with the usage data.

Returns:

  • (String)

    The Id of the usage plan associated with the usage data.