Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.DeleteVolume

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Synopsis

Creating a Request

data DeleteVolume Source #

See: newDeleteVolume smart constructor.

Constructors

DeleteVolume'

Fields

clientRequestToken :: Maybe Text
ontapConfiguration :: Maybe DeleteVolumeOntapConfiguration
For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.
openZFSConfiguration :: Maybe DeleteVolumeOpenZFSConfiguration
For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.
volumeId :: Text
The ID of the volume that you are deleting.

Instances

Instances details

ToJSON DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods toJSON :: DeleteVolume -> Value # toEncoding :: DeleteVolume -> Encoding # toJSONList :: [DeleteVolume] -> Value # toEncodingList :: [DeleteVolume] -> Encoding #
ToHeaders DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods toHeaders :: DeleteVolume -> [Header] #
ToPath DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods toPath :: DeleteVolume -> ByteString #
ToQuery DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods toQuery :: DeleteVolume -> QueryString #
AWSRequest DeleteVolume Source #
Instance details Defined in Amazonka.FSx.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 Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Associated Types type Rep DeleteVolume :: Type -> Type # Methods from :: DeleteVolume -> Rep DeleteVolume x # to :: Rep DeleteVolume x -> DeleteVolume #
Read DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods readsPrec :: Int -> ReadS DeleteVolume # readList :: ReadS [DeleteVolume] # readPrec :: ReadPrec DeleteVolume # readListPrec :: ReadPrec [DeleteVolume] #
Show DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods showsPrec :: Int -> DeleteVolume -> ShowS # show :: DeleteVolume -> String # showList :: [DeleteVolume] -> ShowS #
NFData DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods rnf :: DeleteVolume -> () #
Eq DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods (==) :: DeleteVolume -> DeleteVolume -> Bool # (/=) :: DeleteVolume -> DeleteVolume -> Bool #
Hashable DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods hashWithSalt :: Int -> DeleteVolume -> Int # hash :: DeleteVolume -> Int #
type AWSResponse DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume type AWSResponse DeleteVolume = DeleteVolumeResponse
type Rep DeleteVolume Source #
Instance details Defined in Amazonka.FSx.DeleteVolume type Rep DeleteVolume = D1 ('MetaData "DeleteVolume" "Amazonka.FSx.DeleteVolume" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteVolume'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ontapConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteVolumeOntapConfiguration))) :: (S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteVolumeOpenZFSConfiguration)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteVolume Source #

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:

$sel:clientRequestToken:DeleteVolume', deleteVolume_clientRequestToken - Undocumented member.

DeleteVolume, deleteVolume_ontapConfiguration - For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

DeleteVolume, deleteVolume_openZFSConfiguration - For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

DeleteVolume, deleteVolume_volumeId - The ID of the volume that you are deleting.

Request Lenses

deleteVolume_clientRequestToken :: Lens' DeleteVolume (Maybe Text) Source #

Undocumented member.

deleteVolume_ontapConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOntapConfiguration) Source #

For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

deleteVolume_openZFSConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOpenZFSConfiguration) Source #

For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

deleteVolume_volumeId :: Lens' DeleteVolume Text Source #

The ID of the volume that you are deleting.

Destructuring the Response

data DeleteVolumeResponse Source #

See: newDeleteVolumeResponse smart constructor.

Constructors

DeleteVolumeResponse'

Fields

lifecycle :: Maybe VolumeLifecycle
The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.
ontapResponse :: Maybe DeleteVolumeOntapResponse
Returned after a DeleteVolume request, showing the status of the delete request.
volumeId :: Maybe Text
The ID of the volume that's being deleted.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Associated Types type Rep DeleteVolumeResponse :: Type -> Type # Methods from :: DeleteVolumeResponse -> Rep DeleteVolumeResponse x # to :: Rep DeleteVolumeResponse x -> DeleteVolumeResponse #
Read DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods readsPrec :: Int -> ReadS DeleteVolumeResponse # readList :: ReadS [DeleteVolumeResponse] # readPrec :: ReadPrec DeleteVolumeResponse # readListPrec :: ReadPrec [DeleteVolumeResponse] #
Show DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods showsPrec :: Int -> DeleteVolumeResponse -> ShowS # show :: DeleteVolumeResponse -> String # showList :: [DeleteVolumeResponse] -> ShowS #
NFData DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods rnf :: DeleteVolumeResponse -> () #
Eq DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume Methods (==) :: DeleteVolumeResponse -> DeleteVolumeResponse -> Bool # (/=) :: DeleteVolumeResponse -> DeleteVolumeResponse -> Bool #
type Rep DeleteVolumeResponse Source #
Instance details Defined in Amazonka.FSx.DeleteVolume type Rep DeleteVolumeResponse = D1 ('MetaData "DeleteVolumeResponse" "Amazonka.FSx.DeleteVolume" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteVolumeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeLifecycle)) :: S1 ('MetaSel ('Just "ontapResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteVolumeOntapResponse))) :: (S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteVolumeResponse Source #

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:

DeleteVolumeResponse, deleteVolumeResponse_lifecycle - The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.

$sel:ontapResponse:DeleteVolumeResponse', deleteVolumeResponse_ontapResponse - Returned after a DeleteVolume request, showing the status of the delete request.

DeleteVolume, deleteVolumeResponse_volumeId - The ID of the volume that's being deleted.

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

Response Lenses

deleteVolumeResponse_lifecycle :: Lens' DeleteVolumeResponse (Maybe VolumeLifecycle) Source #

The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.

deleteVolumeResponse_ontapResponse :: Lens' DeleteVolumeResponse (Maybe DeleteVolumeOntapResponse) Source #

Returned after a DeleteVolume request, showing the status of the delete request.

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

The ID of the volume that's being deleted.

deleteVolumeResponse_httpStatus :: Lens' DeleteVolumeResponse Int Source #

The response's http status code.