finspace / Client / delete_kx_volume

delete_kx_volume#

finspace.Client.delete_kx_volume(**kwargs)#

Deletes a volume. You can only delete a volume if it’s not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

See also: AWS API Documentation

Request Syntax

response = client.delete_kx_volume(
    environmentId='string',
    volumeName='string',
    clientToken='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volumeName (string) –

    [REQUIRED]

    The name of the volume that you want to delete.

  • clientToken (string) –

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions