Amazon API Gateway REST API Reference

UsagePlanKeys

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
usageplankey:by-id

Gets the UsagePlanKey resource of a given Id.

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

  • keyId: Required.

    The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

GET Yes
usageplankey:create

Creates a UsagePlanKey resource to associate an existing API key to the specified usage plan.

POST 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
item

The current page of elements from this collection.

GET No


Properties

The UsagePlanKeys resource does not have any properties.

Remarks

See Also

Create and Use Usage Plans