Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteKey

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

Request Syntax


DELETE /metadata/v0/keys/KeyName?forceDelete=ForceDelete HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ForceDelete

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

Note

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

KeyName

The name of the API key to delete.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400