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
trueto delete the key or tofalseto not preemptively delete the API key.Valid values:
true, orfalse.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
-
HTTP Status Code: 403
- InternalServerException
-
HTTP Status Code: 500
- ResourceNotFoundException
-
HTTP Status Code: 404
- ThrottlingException
-
HTTP Status Code: 429
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
