FSx / Client / delete_storage_virtual_machine

delete_storage_virtual_machine#

FSx.Client.delete_storage_virtual_machine(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_storage_virtual_machine(
    ClientRequestToken='string',
    StorageVirtualMachineId='string'
)
Parameters:

  • ClientRequestToken (string) –

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

    This field is autopopulated if not provided.

  • StorageVirtualMachineId (string) –

    [REQUIRED]

    The ID of the SVM that you want to delete.

Return type:

dict

Returns:

Response Syntax

{
    'StorageVirtualMachineId': 'string',
    'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'
}

Response Structure

  • (dict) –

    • StorageVirtualMachineId (string) –

      The ID of the SVM Amazon FSx is deleting.

    • Lifecycle (string) –

      Describes the lifecycle state of the SVM being deleted.

Exceptions

  • FSx.Client.exceptions.BadRequest

  • FSx.Client.exceptions.IncompatibleParameterError

  • FSx.Client.exceptions.InternalServerError

  • FSx.Client.exceptions.StorageVirtualMachineNotFound