DeleteFileCache
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
The DeleteFileCache operation returns while the cache has the
DELETING status. You can check the cache deletion status by
calling the DescribeFileCaches operation, which returns a list of caches in your
account. If you pass the cache ID for a deleted cache, the
DescribeFileCaches operation returns a FileCacheNotFound
error.
Important
The data in a deleted cache is also deleted and can't be recovered by any means.
Request Syntax
{
"ClientRequestToken": "string",
"FileCacheId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-za-z0-9_.-]{0,63}$Required: No
- FileCacheId
-
The ID of the cache that's being deleted.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern:
^(fc-[0-9a-f]{8,})$Required: Yes
Response Syntax
{
"FileCacheId": "string",
"Lifecycle": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FileCacheId
-
The ID of the cache that's being deleted.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern:
^(fc-[0-9a-f]{8,})$ - Lifecycle
-
The cache lifecycle for the deletion request. If the
DeleteFileCacheoperation is successful, this status isDELETING.Type: String
Valid Values:
AVAILABLE | CREATING | DELETING | UPDATING | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequest
-
A generic error indicating a failure with a client request.
HTTP Status Code: 400
- FileCacheNotFound
-
No caches were found based upon supplied parameters.
HTTP Status Code: 400
- IncompatibleParameterError
-
The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
HTTP Status Code: 400
- InternalServerError
-
A generic error indicating a server-side failure.
HTTP Status Code: 500
- ServiceLimitExceeded
-
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
