Class DeleteSnapshotCommandProtected

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 DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

Example

Use a bare-bones client and the command you need to make an API call.

import { FSxClient, DeleteSnapshotCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, DeleteSnapshotCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // DeleteSnapshotRequest
  ClientRequestToken: "STRING_VALUE",
  SnapshotId: "STRING_VALUE", // required
};
const command = new DeleteSnapshotCommand(input);
const response = await client.send(command);
// { // DeleteSnapshotResponse
//   SnapshotId: "STRING_VALUE",
//   Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
// };

Param

DeleteSnapshotCommandInput

Returns

DeleteSnapshotCommandOutput

See

• DeleteSnapshotCommandInput for command's input shape.
• DeleteSnapshotCommandOutput for command's response shape.
• config for FSxClient's config shape.

Throws

BadRequest (client fault)

A generic error indicating a failure with a client request.

Throws

InternalServerError (server fault)

A generic error indicating a server-side failure.

Throws

SnapshotNotFound (client fault)

No Amazon FSx snapshots were found based on the supplied parameters.

Throws

FSxServiceException

Base exception class for all service exceptions from FSx service.