libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StorageGateway.DeleteVolume

Description

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.

Synopsis

Creating a Request

data DeleteVolume Source #

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

See: newDeleteVolume smart constructor.

Constructors

DeleteVolume' 

Fields

  • volumeARN :: Text

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

Instances

Instances details
Eq DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Read DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Show DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Generic DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type Rep DeleteVolume :: Type -> Type #

NFData DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

rnf :: DeleteVolume -> () #

Hashable DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

ToJSON DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

AWSRequest DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type AWSResponse DeleteVolume #

ToHeaders DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

ToPath DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

ToQuery DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

type Rep DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

type Rep DeleteVolume = D1 ('MetaData "DeleteVolume" "Amazonka.StorageGateway.DeleteVolume" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DeleteVolume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

newDeleteVolume Source #

Create a value of DeleteVolume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:volumeARN:DeleteVolume', deleteVolume_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Request Lenses

deleteVolume_volumeARN :: Lens' DeleteVolume Text Source #

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

Destructuring the Response

data DeleteVolumeResponse Source #

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

See: newDeleteVolumeResponse smart constructor.

Constructors

DeleteVolumeResponse' 

Fields

  • volumeARN :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Read DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Show DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Generic DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type Rep DeleteVolumeResponse :: Type -> Type #

NFData DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

rnf :: DeleteVolumeResponse -> () #

type Rep DeleteVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteVolume

type Rep DeleteVolumeResponse = D1 ('MetaData "DeleteVolumeResponse" "Amazonka.StorageGateway.DeleteVolume" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DeleteVolumeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteVolumeResponse Source #

Create a value of DeleteVolumeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:volumeARN:DeleteVolume', deleteVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

$sel:httpStatus:DeleteVolumeResponse', deleteVolumeResponse_httpStatus - The response's http status code.

Response Lenses

deleteVolumeResponse_volumeARN :: Lens' DeleteVolumeResponse (Maybe Text) Source #

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