Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
The data in a deleted backup is also deleted and can't be recovered by any means.
Synopsis
- data DeleteBackup = DeleteBackup' {}
- newDeleteBackup :: Text -> DeleteBackup
- deleteBackup_clientRequestToken :: Lens' DeleteBackup (Maybe Text)
- deleteBackup_backupId :: Lens' DeleteBackup Text
- data DeleteBackupResponse = DeleteBackupResponse' {}
- newDeleteBackupResponse :: Int -> DeleteBackupResponse
- deleteBackupResponse_backupId :: Lens' DeleteBackupResponse (Maybe Text)
- deleteBackupResponse_lifecycle :: Lens' DeleteBackupResponse (Maybe BackupLifecycle)
- deleteBackupResponse_httpStatus :: Lens' DeleteBackupResponse Int
Creating a Request
data DeleteBackup Source #
The request object for the DeleteBackup
operation.
See: newDeleteBackup
smart constructor.
DeleteBackup' | |
|
Instances
Create a value of DeleteBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteBackup'
, deleteBackup_clientRequestToken
- A string of up to 64 ASCII characters that Amazon FSx uses to ensure
idempotent deletion. This parameter is automatically filled on your
behalf when using the CLI or SDK.
DeleteBackup
, deleteBackup_backupId
- The ID of the backup that you want to delete.
Request Lenses
deleteBackup_clientRequestToken :: Lens' DeleteBackup (Maybe Text) Source #
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.
deleteBackup_backupId :: Lens' DeleteBackup Text Source #
The ID of the backup that you want to delete.
Destructuring the Response
data DeleteBackupResponse Source #
The response object for the DeleteBackup
operation.
See: newDeleteBackupResponse
smart constructor.
DeleteBackupResponse' | |
|
Instances
newDeleteBackupResponse Source #
Create a value of DeleteBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackup
, deleteBackupResponse_backupId
- The ID of the backup that was deleted.
DeleteBackupResponse
, deleteBackupResponse_lifecycle
- The lifecycle status of the backup. If the DeleteBackup
operation is
successful, the status is DELETED
.
$sel:httpStatus:DeleteBackupResponse'
, deleteBackupResponse_httpStatus
- The response's http status code.
Response Lenses
deleteBackupResponse_backupId :: Lens' DeleteBackupResponse (Maybe Text) Source #
The ID of the backup that was deleted.
deleteBackupResponse_lifecycle :: Lens' DeleteBackupResponse (Maybe BackupLifecycle) Source #
The lifecycle status of the backup. If the DeleteBackup
operation is
successful, the status is DELETED
.
deleteBackupResponse_httpStatus :: Lens' DeleteBackupResponse Int Source #
The response's http status code.