delete_volume

StorageGateway.Client.delete_volume(**kwargs)

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

See also: AWS API Documentation

Request Syntax

response = client.delete_volume(
    VolumeARN='string'
)

Parameters

VolumeARN (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Return type

dict

Returns

Response Syntax

{
    'VolumeARN': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.

  • VolumeARN (string) --

    The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException
• StorageGateway.Client.exceptions.InternalServerError

Examples

Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.

response = client.delete_volume(
    VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)

print(response)

Expected Output:

{
    'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'ResponseMetadata': {
        '...': '...',
    },
}