RetroSearch Browse

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/APIGateway/Types/GetUsageRequest.html below:

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

Overview Note:

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

{
  usage_plan_id: "String",   key_id: "String",
  start_date: "String",   end_date: "String",   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

#end_date ⇒ String [Required] The ending date (e.g., 2016-12-31) of the usage data.
#key_id ⇒ String The Id of the API key associated with the resultant usage data.
#limit ⇒ Integer The maximum number of returned results per page.
#position ⇒ String The current pagination position in the paged result set.
#start_date ⇒ String [Required] The starting date (e.g., 2016-01-01) of the usage data.
#usage_plan_id ⇒ String [Required] The Id of the usage plan associated with the usage data.

Instance Attribute Details #end_date ⇒ String

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

#key_id ⇒ String

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

#limit ⇒ Integer

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

#position ⇒ String

The current pagination position in the paged result set.

#start_date ⇒ String

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

#usage_plan_id ⇒ String

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4