Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteSnapshot

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.

Request Syntax


{
   "ClientRequestToken": "string",
   "SnapshotId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

SnapshotId

The ID of the snapshot that you want to delete.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

Required: Yes

Response Syntax


{
   "Lifecycle": "string",
   "SnapshotId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Lifecycle

The lifecycle status of the snapshot. If the DeleteSnapshot operation is successful, this status is DELETING.

Type: String

Valid Values: PENDING | CREATING | DELETING | AVAILABLE

SnapshotId

The ID of the deleted snapshot.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

SnapshotNotFound

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

HTTP Status Code: 400