AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . apigateway ]
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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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'
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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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)