paws.storage (version 0.1.12)

fsx_delete_backup: Deletes an Amazon FSx backup, deleting its contents

Description

Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The delete_backup call returns instantly. The backup will not show up in later describe_backups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Usage

fsx_delete_backup(BackupId, ClientRequestToken)

Value

A list with the following syntax:

list(
  BackupId = "string",
  Lifecycle = "AVAILABLE"|"CREATING"|"TRANSFERRING"|"DELETED"|"FAILED"|"PENDING"
)

Arguments

BackupId

[required] The ID of the backup you want to delete.

ClientRequestToken

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

Request syntax

svc$delete_backup(
  BackupId = "string",
  ClientRequestToken = "string"
)

Examples

if (FALSE) {
# This operation deletes an Amazon FSx file system backup.
svc$delete_backup(
  BackupId = "backup-03e3c82e0183b7b6b"
)
}