[ aws . apigateway ]

create-api-key

Description

Create an ApiKey resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-api-key
[--name <value>]
[--description <value>]
[--enabled | --no-enabled]
[--generate-distinct-id | --no-generate-distinct-id]
[--value <value>]
[--stage-keys <value>]
[--customer-id <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the ApiKey.

--description (string)

The description of the ApiKey.

--enabled | --no-enabled (boolean)

Specifies whether the ApiKey can be used by callers.

--generate-distinct-id | --no-generate-distinct-id (boolean)

Specifies whether (true ) or not (false ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

--value (string)

Specifies a value of the API key.

--stage-keys (list)

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

(structure)

A reference to a unique stage identified in the format {restApiId}/{stage} .

restApiId -> (string)

The string identifier of the associated RestApi.

stageName -> (string)

The stage name associated with the stage key.

Shorthand Syntax:

restApiId=string,stageName=string ...

JSON Syntax:

[
  {
    "restApiId": "string",
    "stageName": "string"
  }
  ...
]

--customer-id (string)

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

--tags (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create an API key that is enabled for an existing API and Stage

Command:

aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev'

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)