CmdID

CmdID / aws / aws apigateway

aws apigateway get-usage-plan-keys

Gets all the usage plan keys representing the API keys added to a specified usage plan. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To get the list of API keys associated with a Usage Plan

The following get-usage-plan-keys example gets the list of API keys associated with the specified usage plan.

aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3Identify
--usage-plan-idThe Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
Its output
{
    "items": [
        {
            "id": "1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu",
            "type": "API_KEY",
            "name": "MyApiKey"
        }
    ]
}

For more information, see Set up usage plans for REST APIs in API Gateway in the Amazon API Gateway Developer Guide.

Options

4 in the AWS CLI reference
--limitThe maximum number of returned results per page.
--name-queryA query parameter specifying the name of the to-be-returned usage plan keys.
--positionThe current pagination position in the paged result set.
--usage-plan-idThe Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.