DeleteUsagePlanKey - Amazon API Gateway

DeleteUsagePlanKey

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

Request Syntax

DELETE /usageplans/usageplanId/keys/keyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

keyId

The Id of the UsagePlanKey resource to be deleted.

Required: Yes

usageplanId

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: