Steps to configure a usage plan in API Gateway

The following steps outline how you, as the API owner, create and configure a usage plan for your customers.

To configure a usage plan

1. Create one or more APIs, configure the methods to require an API key, and deploy the APIs to stages.

   For more information about how how to configure a method to require an API key, see Require an API key on a method.

2. Generate or import API keys to distribute to application developers (your customers) who will be using your API.

   For more information about how to generate or import API keys, see Create an API key.

3. Create the usage plan with the desired throttle and quota limits, and then associate API stages and API keys with the usage plan.

   For more information about how to create the usage plan, see Create a usage plan.

Callers of the API must supply an assigned API key in the x-api-key header in requests to the API.

For a complete AWS CloudFormation template that creates and associates a usage plan with a new stage and an API key, see Create and configure API keys and usage plans with AWS CloudFormation.

Note

To include API methods in a usage plan, you must configure individual API methods to require an API key. For best practices to consider, see Best practices for API keys and usage plans.