create-usage-plan-key¶

Description¶

Creates a usage plan key for adding an existing API key to a usage plan.

Synopsis¶

  create-usage-plan-key
--usage-plan-id <value>
--key-id <value>
--key-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--usage-plan-id (string)

The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

--key-id (string)

The identifier of a UsagePlanKey resource for a plan customer.

--key-type (string)

The type of a UsagePlanKey resource for a plan customer.

--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 .

Associate an existing API key with a Usage Plan

Command:

aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5

Output¶

id -> (string)

The Id of a usage plan key.

type -> (string)

The type of a usage plan key. Currently, the valid key type is API_KEY .

value -> (string)

The value of a usage plan key.

name -> (string)

The name of a usage plan key.

Table of Contents

Feedback

User Guide