Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DeleteStorageVirtualMachineCommandProtected

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.

Example

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

import { FSxClient, DeleteStorageVirtualMachineCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, DeleteStorageVirtualMachineCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // DeleteStorageVirtualMachineRequest
ClientRequestToken: "STRING_VALUE",
StorageVirtualMachineId: "STRING_VALUE", // required
};
const command = new DeleteStorageVirtualMachineCommand(input);
const response = await client.send(command);
// { // DeleteStorageVirtualMachineResponse
// StorageVirtualMachineId: "STRING_VALUE",
// Lifecycle: "CREATED" || "CREATING" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING",
// };

Param

DeleteStorageVirtualMachineCommandInput

Returns

DeleteStorageVirtualMachineCommandOutput

See

Throws

BadRequest (client fault)

A generic error indicating a failure with a client request.

Throws

IncompatibleParameterError (client fault)

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.

Throws

InternalServerError (server fault)

A generic error indicating a server-side failure.

Throws

StorageVirtualMachineNotFound (client fault)

No FSx for ONTAP SVMs were found based upon the supplied parameters.

Throws

FSxServiceException

Base exception class for all service exceptions from FSx service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods