CmdID

CmdID / aws / aws apigateway

aws apigateway get-api-key

Gets information about the current ApiKey resource. AWS CLI reference

1 example 2 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 information about a specific API key

The following get-api-key example gets information about a specific API key.

aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blkIdentify
--api-keyThe identifier of the ApiKey resource.
Its output
{
    "description": "My first key",
    "enabled": true,
    "stageKeys": [
        "a1b2c3d4e5/dev",
        "e5d4c3b2a1/dev"
    ],
    "lastUpdatedDate": 1456184515,
    "createdDate": 1456184452,
    "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
    "name": "My key"
}

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

Options

2 in the AWS CLI reference
--api-keyThe identifier of the ApiKey resource.
--include-valueA boolean flag to specify whether (true) or not (false) the result contains the key value.