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

Class: Aws::APIGateway::Types::Usage

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

Overview

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#end_date ⇒ String

The ending date of the usage data.

Returns:

  • (String) —

    The ending date of the usage data.

#items ⇒ Hash<String,Array<Array<Integer>>>

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "`{api_key}`" : [ [0, 100], [10, 90], [100, 10]]}, where `{api_key}` stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Returns:

  • (Hash<String,Array<Array<Integer>>>) —

    The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan.

#position ⇒ String

Returns:

  • (String)

#start_date ⇒ String

The starting date of the usage data.

Returns:

  • (String) —

    The starting date of the usage data.

#usage_plan_id ⇒ String

The plan Id associated with this usage data.

Returns:

  • (String) —

    The plan Id associated with this usage data.