API keys and usage plans in AWS - Commands & Configuration

Introduction

API keys help control who can use your web services and how much they can use them. Usage plans set limits on how many requests each user can make to keep your service stable and fair.

When you want to limit how many times a user can call your API each day to avoid overload.

When you need to track which users are using your API and how much.

When you want to give different users different levels of access or limits.

When you want to protect your API from being used too much by a single user.

When you want to organize your API users and control their usage easily.

Commands

This command creates a new API key named 'my-api-key' and enables it so it can be used immediately.

Terminal

aws apigateway create-api-key --name my-api-key --enabled

Expected Output

{

    "id": "a1b2c3d4",

    "value": "xYz123AbCdEf456",

    "name": "my-api-key",

    "enabled": true

}

→

--name - Sets the name of the API key.

→

--enabled - Activates the API key immediately.

This command creates a usage plan named 'my-usage-plan' that limits users to 100 requests at once and 50 requests per second, with a total of 1000 requests allowed per day.

Terminal

aws apigateway create-usage-plan --name my-usage-plan --throttle burstLimit=100,rateLimit=50 --quota limit=1000,period=DAY

Expected Output

{

    "id": "u1v2w3x4",

    "name": "my-usage-plan",

    "throttle": {

        "burstLimit": 100,

        "rateLimit": 50.0

    },

    "quota": {

        "limit": 1000,

        "period": "DAY"

    }

}

→

--throttle - Sets the maximum burst and steady request rate.

→

--quota - Sets the total allowed requests in a time period.

This command links the API key 'a1b2c3d4' to the usage plan 'u1v2w3x4' so the key follows the usage limits.

Terminal

aws apigateway create-usage-plan-key --usage-plan-id u1v2w3x4 --key-id a1b2c3d4 --key-type API_KEY

Expected Output

{

    "id": "k1l2m3n4",

    "type": "API_KEY",

    "value": "xYz123AbCdEf456",

    "name": "my-api-key"

}

→

--usage-plan-id - Specifies which usage plan to link.

→

--key-id - Specifies which API key to link.

→

--key-type - Defines the type of key being linked.

This command lists all usage plans to verify the created plans and their settings.

Terminal

aws apigateway get-usage-plans

Expected Output

{

    "items": [

        {

            "id": "u1v2w3x4",

            "name": "my-usage-plan",

            "throttle": {

                "burstLimit": 100,

                "rateLimit": 50.0

            },

            "quota": {

                "limit": 1000,

                "period": "DAY"

            }

        }

    ]

}

Key Concept

If you remember nothing else from this pattern, remember: API keys identify users, and usage plans control how much each user can use your API.

Common Mistakes

Creating an API key but not linking it to a usage plan.

The API key will work but won't have any usage limits, risking overload.

Always link your API keys to a usage plan to enforce limits.

Setting usage plan limits too low or too high without testing.

Too low limits block legitimate users; too high limits fail to protect your API.

Start with reasonable limits and adjust based on real usage.

Not enabling the API key after creation.

Disabled keys cannot be used to access the API.

Use the --enabled flag when creating the API key or enable it later.

Summary

Create an API key to identify users of your API.

Create a usage plan to set limits on how much the API can be used.

Link the API key to the usage plan to apply those limits to the user.

Practice

1. What is the main purpose of an API key in AWS API Gateway?

easy

A. To monitor server CPU usage

B. To store user data securely

C. To encrypt API responses

D. To identify and control who can access the API

Solution

1. Step 1: Understand API key role

   An API key is used to identify the client calling the API.

2. Step 2: Identify purpose in AWS API Gateway

   It helps control and track who can access the API, not data storage or encryption.

3. Final Answer:

   To identify and control who can access the API -> Option D

4. Quick Check:

   API key = identify and control access [OK]

Hint: API keys identify users, not store or encrypt data [OK]

Common Mistakes:

• Confusing API keys with encryption keys
• Thinking API keys store user data
• Assuming API keys monitor server metrics

2. Which of the following is the correct way to associate an API key with a usage plan in AWS API Gateway?

easy

A. Create a usage plan, then add the API key to it

B. Create an API key, then add a usage plan to it

C. Create a usage plan and API key separately without linking

D. Create an API key inside the usage plan settings

Solution

1. Step 1: Understand usage plan and API key relationship

   Usage plans define limits and must have API keys linked to enforce them.

2. Step 2: Correct linking process

   You create a usage plan first, then add API keys to it to apply limits.

3. Final Answer:

   Create a usage plan, then add the API key to it -> Option A

4. Quick Check:

   Usage plan first, then add API key [OK]

Hint: Link API keys by adding them to usage plans [OK]

Common Mistakes:

• Trying to add usage plans to API keys
• Not linking keys and plans at all
• Assuming API keys are created inside usage plans

3. Given this AWS CLI command output showing usage plan limits:

{"throttle": {"rateLimit": 100, "burstLimit": 200}, "quota": {"limit": 1000, "period": "DAY"}}

What does this usage plan enforce?

medium

A. Max 1000 requests per second, burst up to 200, and 100 requests per day

B. Max 200 requests per second, burst up to 100, and 1000 requests per day

C. Max 100 requests per second, burst up to 200, and 1000 requests per day

D. No limits on requests per second or daily quota

Solution

1. Step 1: Interpret throttle limits

   RateLimit 100 means 100 requests per second max, burstLimit 200 allows short bursts up to 200 requests.

2. Step 2: Interpret quota limits

   Quota limit 1000 per DAY means max 1000 requests allowed in one day.

3. Final Answer:

   Max 100 requests per second, burst up to 200, and 1000 requests per day -> Option C

4. Quick Check:

   Throttle = 100/sec + 200 burst, Quota = 1000/day [OK]

Hint: Throttle = per second, quota = daily limit [OK]

Common Mistakes:

• Mixing burstLimit with rateLimit
• Confusing quota limit with per second limit
• Ignoring the quota period

4. You created an API key and a usage plan, but API calls with the key are not limited by the usage plan. What is the most likely cause?

medium

A. The usage plan has no throttle or quota limits set

B. The API key is not associated with the usage plan

C. The API key is expired

D. The API Gateway stage is not deployed

Solution

1. Step 1: Check API key and usage plan link

   Usage plans only apply limits if the API key is linked to them.

2. Step 2: Verify other causes

   While no limits or deployment can cause issues, the key not linked means no limits apply.

3. Final Answer:

   The API key is not associated with the usage plan -> Option B

4. Quick Check:

   Key must be linked to usage plan for limits [OK]

Hint: Check if API key is linked to usage plan [OK]

Common Mistakes:

• Assuming usage plan limits apply without linking keys
• Ignoring deployment status
• Confusing expired keys with unlinked keys

5. You want to create a usage plan that limits users to 5000 requests per month and 50 requests per second with a burst of 100. You also want to track usage per API key. Which steps correctly achieve this?

hard

A. Create usage plan with quota 5000/month and throttle 50/sec burst 100, then add API keys to the plan

B. Create API keys with limits, then assign usage plan to each key

C. Create usage plan with limits, deploy API, no need to link API keys

D. Set limits on API Gateway stage, then create API keys without usage plan

Solution

1. Step 1: Define usage plan with required limits

   Set quota to 5000 per month and throttle to 50 requests per second with burst 100.

2. Step 2: Link API keys to usage plan

   Adding API keys to the usage plan enables tracking and enforcement of limits per key.

3. Final Answer:

   Create usage plan with quota 5000/month and throttle 50/sec burst 100, then add API keys to the plan -> Option A

4. Quick Check:

   Usage plan sets limits + keys linked for tracking [OK]

Hint: Set limits in usage plan, then add API keys [OK]

Common Mistakes:

• Trying to set limits on API keys directly
• Not linking API keys to usage plan
• Setting limits only on API Gateway stage