amazonka-storagegateway-1.4.5: Amazon Storage Gateway SDK.

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

Network.AWS.StorageGateway.DeleteVolume

Contents

Description

Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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

deleteVolume #

Creates a value of DeleteVolume with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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

data DeleteVolume #

A JSON object containing the 'DeleteVolumeInput$VolumeARN' to delete.

See: deleteVolume smart constructor.

Instances

Eq DeleteVolume # 
Data DeleteVolume # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteVolume -> c DeleteVolume #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteVolume #

toConstr :: DeleteVolume -> Constr #

dataTypeOf :: DeleteVolume -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteVolume) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteVolume) #

gmapT :: (forall b. Data b => b -> b) -> DeleteVolume -> DeleteVolume #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteVolume -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteVolume -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteVolume -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteVolume -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteVolume -> m DeleteVolume #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteVolume -> m DeleteVolume #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteVolume -> m DeleteVolume #

Read DeleteVolume # 
Show DeleteVolume # 
Generic DeleteVolume # 

Associated Types

type Rep DeleteVolume :: * -> * #

Hashable DeleteVolume # 
ToJSON DeleteVolume # 
NFData DeleteVolume # 

Methods

rnf :: DeleteVolume -> () #

AWSRequest DeleteVolume # 
ToQuery DeleteVolume # 
ToPath DeleteVolume # 
ToHeaders DeleteVolume # 
type Rep DeleteVolume # 
type Rep DeleteVolume = D1 (MetaData "DeleteVolume" "Network.AWS.StorageGateway.DeleteVolume" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" True) (C1 (MetaCons "DeleteVolume'" PrefixI True) (S1 (MetaSel (Just Symbol "_dvVolumeARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DeleteVolume # 

Request Lenses

dvVolumeARN :: Lens' DeleteVolume Text #

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

Destructuring the Response

deleteVolumeResponse #

Creates a value of DeleteVolumeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dvrsVolumeARN - The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
  • dvrsResponseStatus - -- | The response status code.

data DeleteVolumeResponse #

A JSON object containing the of the storage volume that was deleted

See: deleteVolumeResponse smart constructor.

Instances

Eq DeleteVolumeResponse # 
Data DeleteVolumeResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteVolumeResponse -> c DeleteVolumeResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteVolumeResponse #

toConstr :: DeleteVolumeResponse -> Constr #

dataTypeOf :: DeleteVolumeResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteVolumeResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteVolumeResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteVolumeResponse -> DeleteVolumeResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteVolumeResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteVolumeResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteVolumeResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteVolumeResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteVolumeResponse -> m DeleteVolumeResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteVolumeResponse -> m DeleteVolumeResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteVolumeResponse -> m DeleteVolumeResponse #

Read DeleteVolumeResponse # 
Show DeleteVolumeResponse # 
Generic DeleteVolumeResponse # 
NFData DeleteVolumeResponse # 

Methods

rnf :: DeleteVolumeResponse -> () #

type Rep DeleteVolumeResponse # 
type Rep DeleteVolumeResponse = D1 (MetaData "DeleteVolumeResponse" "Network.AWS.StorageGateway.DeleteVolume" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "DeleteVolumeResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvrsVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dvrsVolumeARN :: Lens' DeleteVolumeResponse (Maybe Text) #

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

dvrsResponseStatus :: Lens' DeleteVolumeResponse Int #

  • - | The response status code.