AWS CLI: api gateway get-usage not returning usage of all keys

Question

I'm trying to see usage of each API key in my usage plan. However when I run

aws apigateway get-usage --usage-plan-id ***** --start-date 2021-01-18 --end-date 2021-01-24 --profile prod --region ap-south-1 >> week04.txt

It returns usage of only few keys. When I try to do that from the AWS management console from here

It gives me the usage of the same few keys. I have to manually click every single key and generate the report which is very tedious. What am I doing wrong? Please help.

try passing --no-paginate to get-usage?

Balu Vyamajala
– Balu Vyamajala

2021-01-25 07:13:34 +00:00
Commented Jan 25, 2021 at 7:13 — Balu Vyamajala
– Balu Vyamajala, Commented Jan 25, 2021 at 7:13

Balu Vyamajala · Accepted Answer · 2021-01-25 07:29:22Z

2

We can combine get-usage-plan-keys and get-usage with xargs to extract for every api key at once.

aws apigateway  get-usage-plan-keys --usage-plan-id xx44ww | jq -r ".items[].id" | xargs -I {} aws apigateway get-usage --usage-plan-id xg4j0w --key-id {} --start-date 2021-01-01 --end-date 2021-01-24 --no-paginate > output.json

Breaking it down for better readability:

Getting usage plan keys:

aws apigateway  get-usage-plan-keys --usage-plan-id xx44ww

Extracting plan keys

| jq -r ".items[].id"

loop for every api key id with xargs

aws apigateway get-usage --usage-plan-id xg4j0w --key-id {} --start-date 2021-01-01 --end-date 2021-01-24 --no-paginate

edited Jan 25, 2021 at 7:29

answered Jan 25, 2021 at 7:04

Balu Vyamajala

10.5k1 gold badge28 silver badges51 bronze badges

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

2 Comments

Marcin Over a year ago

Hi. Just wonder if you could get same with just using --query of aws cli, without the need for jq or xargs?

coryflucas Over a year ago

Not sure about replacing the xargs, but you can remove the need for jq:

aws apigateway get-usage-plan-keys --usage-plan-id xxxxxx --query "items[*].id" --output text | xargs -n1 aws apigateway get-usage --usage-plan-id xxxxxx --start-date YYYY-MM-DD --end-date YYYY-MM-DD --no-paginate --key-id > output.json

Collectives™ on Stack Overflow

AWS CLI: api gateway get-usage not returning usage of all keys

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related