Amazon API Gateway REST API Reference

Usage

Represents the usage data of a usage plan.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
next

The next page of elements from this collection. Not valid for the last element of the collection.

GET No
first

The first page of elements from this collection.

GET No
usage:update

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

This link relation offers the following templated variable(s):

  • keyId: Required.

    The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

PATCH Yes


Properties

{
  "usagePlanId" : "String",
  "startDate" : "String",
  "endDate" : "String",
  "values" : {
    "String" : [ [ "Long" ] ]
  }
}

  • usagePlanId
  • The plan Id associated with this usage data.

  • startDate
  • The starting date of the usage data.

  • endDate
  • The ending date of the usage data.

  • values
  • 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].

Remarks

See Also

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