Skip to content

Deletes an Amazon FSx for OpenZFS snapshot

Description

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

The delete_snapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

Usage

fsx_delete_snapshot(ClientRequestToken, SnapshotId)

Arguments

  • 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 Command Line Interface (CLI) or an Amazon Web Services SDK.

  • SnapshotId

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

Value

A list with the following syntax:

list(
  SnapshotId = "string",
  Lifecycle = "PENDING"|"CREATING"|"DELETING"|"AVAILABLE"
)

Request syntax

svc$delete_snapshot(
  ClientRequestToken = "string",
  SnapshotId = "string"
)