DeleteVolume - Amazon FSx

DeleteVolume

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Request Syntax

{ "ClientRequestToken": "string", "OntapConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean }, "OpenZFSConfiguration": { "Options": [ "string" ] }, "VolumeId": "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 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

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

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

Required: No

OntapConfiguration

For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

Type: DeleteVolumeOntapConfiguration object

Required: No

OpenZFSConfiguration

For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

Type: DeleteVolumeOpenZFSConfiguration object

Required: No

VolumeId

The ID of the volume that you are deleting.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Required: Yes

Response Syntax

{ "Lifecycle": "string", "OntapResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "VolumeId": "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 state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.

Type: String

Valid Values: CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLE

OntapResponse

Returned after a DeleteVolume request, showing the status of the delete request.

Type: DeleteVolumeOntapResponse object

VolumeId

The ID of the volume that's being deleted.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

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

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

VolumeNotFound

No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: