[ aws . apigateway ]

delete-usage-plan-key

Description

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-usage-plan-key
--usage-plan-id <value>
--key-id <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-deleted UsagePlanKey resource representing a plan customer.

--key-id (string)

[Required] The Id of the UsagePlanKey resource to be deleted.

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

To remove an API key from a Usage Plan

Command:

aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

Output

None