[ aws . apigateway ]

get-api-key

Description

Gets information about the current ApiKey resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-api-key
--api-key <value>
[--include-value | --no-include-value]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--api-key (string)

[Required] The identifier of the ApiKey resource.

--include-value | --no-include-value (boolean)

A boolean flag to specify whether (true ) or not (false ) the result contains the key value.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get the information about a specific API key

Command:

aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

Output:

{
    "description": "My first key",
    "enabled": true,
    "stageKeys": [
        "a1b2c3d4e5/dev",
        "e5d4c3b2a1/dev"
    ],
    "lastUpdatedDate": 1456184515,
    "createdDate": 1456184452,
    "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
    "name": "My key"
}

Output

id -> (string)

The identifier of the API Key.

value -> (string)

The value of the API Key.

name -> (string)

The name of the API Key.

customerId -> (string)

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description -> (string)

The description of the API Key.

enabled -> (boolean)

Specifies whether the API Key can be used by callers.

createdDate -> (timestamp)

The timestamp when the API Key was created.

lastUpdatedDate -> (timestamp)

The timestamp when the API Key was last updated.

stageKeys -> (list)

A list of Stage resources that are associated with the ApiKey resource.

(string)

tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)