Update AWS Lambda API Key Usage Plans with boto3

Question

I have an API Key associated with a particular usage plan. How do I use boto3 to update the usage plan to another usage plan?

I've tried the following methods:

update_api_key() // add, remove and replace operations do not have usage plan path update_usage_plan() // add, remove and replace operations do not have usage plan path

I thought about remove the key from the plan then re-adding but there are no usage plan paths.

The doc says: Each op operation can have only one path associated with it — helloV
– helloV, Commented Sep 16, 2016 at 3:54
I'm only using one path. My point is that none of the paths relate to the usage plan. — Jason Strimpel
– Jason Strimpel, Commented Sep 16, 2016 at 4:10

luismy · Accepted Answer · 2018-01-25 14:22:35Z

4

I don't know if this is of any help but I run into a similar problem and I did find this post which did the trick for me!

So in my case I wanted to add a new Rest API Stage into an existing Usage Plan so the python script I used was:

import boto3

apigateway = boto3.client('apigateway')
response = apigateway.update_usage_plan(
                    usagePlanId='YOUR_USAGE_PLAN_ID_HERE', 
                    patchOperations=[
                        {
                           'op': 'add',
                           'path': '/apiStages',
                           'value': 'YOUR_REST_API_ID_HERE:v0'
                        }
                    ]
            )

print(response)

I hope this helps :)

Luismy

edited Jan 25, 2018 at 14:22

answered Jan 25, 2018 at 11:14

luismy

715 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Amos Long Over a year ago

Thanks, for the link. It shed light on the format expected by 'value'. In my case it was {'op': 'add', 'path': '/apiStages', 'value': '12l0qhemog:TEST'}

RyanG · Accepted Answer · 2016-09-16 19:32:03Z

3

You are looking for create_usage_plan_key

i.e.

response = client.create_usage_plan_key(
    usagePlanId='12345',
    keyId='[API_KEY_ID]',
    keyType='API_KEY'
)

answered Sep 16, 2016 at 19:32

RyanG

4,15227 silver badges19 bronze badges

2 Comments

Jason Strimpel Over a year ago

botocore.exceptions.ClientError: An error occurred (ConflictException) when calling the CreateUsagePlanKey operation: Usage Plan XYZ cannot be added because API Key cannot reference multiple Usage Plans with the same API Stage: ABC:beta

RyanG Over a year ago

This call does not add new API Keys, it adds new associations between API Keys and Usage Plans. The error message you posted is unrelated. You can also use remove_usage_plan_key to remove the associations between API Keys and Usage Plans.

Collectives™ on Stack Overflow

Update AWS Lambda API Key Usage Plans with boto3

2 Answers 2

1 Comment

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related