DeleteStorageVirtualMachine - Amazon FSx

DeleteStorageVirtualMachine

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

Request Syntax

{ "ClientRequestToken": "string", "StorageVirtualMachineId": "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

StorageVirtualMachineId

The ID of the SVM that you want to delete.

Type: String

Length Constraints: Fixed length of 21.

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

Required: Yes

Response Syntax

{ "Lifecycle": "string", "StorageVirtualMachineId": "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

Describes the lifecycle state of the SVM being deleted.

Type: String

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

StorageVirtualMachineId

The ID of the SVM Amazon FSx is deleting.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^(svm-[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

StorageVirtualMachineNotFound

No Amazon FSx for NetApp ONTAP SVMs 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: