DeleteBackup
Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in
later DescribeBackups calls.
Important
The data in a deleted backup is also deleted and can't be recovered by any means.
Request Syntax
{
"BackupId": "string",
"ClientRequestToken": "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.
- BackupId
-
The ID of the backup that you want to delete.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern:
^(backup-[0-9a-f]{8,})$Required: Yes
- ClientRequestToken
-
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the AWS CLI or SDK.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-za-z0-9_.-]{0,63}$Required: No
Response Syntax
{
"BackupId": "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.
- BackupId
-
The ID of the backup that was deleted.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern:
^(backup-[0-9a-f]{8,})$ - Lifecycle
-
The lifecycle status of the backup. If the
DeleteBackupoperation is successful, the status isDELETED.Type: String
Valid Values:
AVAILABLE | CREATING | TRANSFERRING | DELETED | FAILED | PENDING | COPYING
Errors
For information about the errors that are common to all actions, see Common Errors.
- BackupBeingCopied
-
You can't delete a backup while it's being copied.
HTTP Status Code: 400
- BackupInProgress
-
Another backup is already under way. Wait for completion before initiating additional backups of this file system.
HTTP Status Code: 400
- BackupNotFound
-
No Amazon FSx backups were found based upon the supplied parameters.
HTTP Status Code: 400
- BackupRestoring
-
You can't delete a backup while it's being used to restore a file system.
HTTP Status Code: 400
- BadRequest
-
A generic error indicating a failure with a client request.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
