fsx_delete_backup: Deletes an Amazon FSx backup, deleting its contents

Description Usage Arguments Value Request syntax Examples

View source: R/fsx_operations.R

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

1
fsx_delete_backup(BackupId, ClientRequestToken)

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.

Value

A list with the following syntax:

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

Request syntax

1
2
3
4
svc$delete_backup(
  BackupId = "string",
  ClientRequestToken = "string"
)

Examples

1
2
3
4
5
6
7
## Not run: 
# This operation deletes an Amazon FSx file system backup.
svc$delete_backup(
  BackupId = "backup-03e3c82e0183b7b6b"
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.