Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

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-usage-plan-key

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--usage-plan-id (string)

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

--key-id (string)

[Required] The identifier of a UsagePlanKey resource for a plan customer.

--key-type (string)

[Required] The type of a UsagePlanKey resource for a plan customer.

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

See 'aws help' for descriptions of global parameters.

Examples

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.