API Gateway Usage Plans & API Keys

  • Service that allow you to make API Gateway API as a service to make money from customer.
  • Usage Plans:
    • to specify the following
      • who can access the API stages and method
      • how much and how fast
    • uses API keys to identify API client and access
      • API Key is a string value that unique for a customer to provide their access
    • configure throttling limits and quota limtis that enforced on individual client
      • throttle is applied to the API keys
    • Can configure quota limits (maximum number of total request)

Step by step

  1. Create the APIs and configure to require API key. Deploy the APIs to stages
  2. Generate or import API keys to distribute to your customers
  3. Create the usage plan with the desired throttle and quota limits
  4. Associate API stages and API keys with usage plan

Note: The caller must supply assigned API key in the x-api-key header in requests to consume your api