Amazonka.StorageGateway.DeleteVolume

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.

Creating a Request

data DeleteVolume

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

ToJSON DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

toJSON :: DeleteVolume -> Value

toEncoding :: DeleteVolume -> Encoding

toJSONList :: [DeleteVolume] -> Value

toEncodingList :: [DeleteVolume] -> Encoding

ToHeaders DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

toHeaders :: DeleteVolume -> [Header]

ToPath DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

toPath :: DeleteVolume -> ByteString

ToQuery DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

toQuery :: DeleteVolume -> QueryString

AWSRequest DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type AWSResponse DeleteVolume

Methods

request :: (Service -> Service) -> DeleteVolume -> Request DeleteVolume

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteVolume -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteVolume)))

Generic DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type Rep DeleteVolume :: Type -> Type

Methods

from :: DeleteVolume -> Rep DeleteVolume x

to :: Rep DeleteVolume x -> DeleteVolume

Read DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

readsPrec :: Int -> ReadS DeleteVolume

readList :: ReadS [DeleteVolume]

readPrec :: ReadPrec DeleteVolume

readListPrec :: ReadPrec [DeleteVolume]

Show DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

showsPrec :: Int -> DeleteVolume -> ShowS

show :: DeleteVolume -> String

showList :: [DeleteVolume] -> ShowS

NFData DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

rnf :: DeleteVolume -> ()

Eq DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

(==) :: DeleteVolume -> DeleteVolume -> Bool

(/=) :: DeleteVolume -> DeleteVolume -> Bool

Hashable DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

hashWithSalt :: Int -> DeleteVolume -> Int

hash :: DeleteVolume -> Int

type AWSResponse DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

type AWSResponse DeleteVolume = DeleteVolumeResponse

type Rep DeleteVolume

Defined in Amazonka.StorageGateway.DeleteVolume

type Rep DeleteVolume = D1 ('MetaData "DeleteVolume" "Amazonka.StorageGateway.DeleteVolume" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DeleteVolume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteVolume

Arguments

:: Text

DeleteVolume

-> DeleteVolume

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:

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

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

Destructuring the Response

data DeleteVolumeResponse

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

Generic DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

Associated Types

type Rep DeleteVolumeResponse :: Type -> Type

Methods

from :: DeleteVolumeResponse -> Rep DeleteVolumeResponse x

to :: Rep DeleteVolumeResponse x -> DeleteVolumeResponse

Read DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

readsPrec :: Int -> ReadS DeleteVolumeResponse

readList :: ReadS [DeleteVolumeResponse]

readPrec :: ReadPrec DeleteVolumeResponse

readListPrec :: ReadPrec [DeleteVolumeResponse]

Show DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

showsPrec :: Int -> DeleteVolumeResponse -> ShowS

show :: DeleteVolumeResponse -> String

showList :: [DeleteVolumeResponse] -> ShowS

NFData DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

rnf :: DeleteVolumeResponse -> ()

Eq DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

Methods

(==) :: DeleteVolumeResponse -> DeleteVolumeResponse -> Bool

(/=) :: DeleteVolumeResponse -> DeleteVolumeResponse -> Bool

type Rep DeleteVolumeResponse

Defined in Amazonka.StorageGateway.DeleteVolume

type Rep DeleteVolumeResponse = D1 ('MetaData "DeleteVolumeResponse" "Amazonka.StorageGateway.DeleteVolume" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" '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

Arguments

:: Int

$sel:httpStatus:DeleteVolumeResponse'

-> DeleteVolumeResponse

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:

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)

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

deleteVolumeResponse_httpStatus :: Lens' DeleteVolumeResponse Int

The response's http status code.