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 |
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
Synopsis
- data DeleteVolume = DeleteVolume' {}
- newDeleteVolume :: Text -> DeleteVolume
- deleteVolume_clientRequestToken :: Lens' DeleteVolume (Maybe Text)
- deleteVolume_ontapConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOntapConfiguration)
- deleteVolume_openZFSConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOpenZFSConfiguration)
- deleteVolume_volumeId :: Lens' DeleteVolume Text
- data DeleteVolumeResponse = DeleteVolumeResponse' {}
- newDeleteVolumeResponse :: Int -> DeleteVolumeResponse
- deleteVolumeResponse_lifecycle :: Lens' DeleteVolumeResponse (Maybe VolumeLifecycle)
- deleteVolumeResponse_ontapResponse :: Lens' DeleteVolumeResponse (Maybe DeleteVolumeOntapResponse)
- deleteVolumeResponse_volumeId :: Lens' DeleteVolumeResponse (Maybe Text)
- deleteVolumeResponse_httpStatus :: Lens' DeleteVolumeResponse Int
Creating a Request
data DeleteVolume Source #
See: newDeleteVolume
smart constructor.
DeleteVolume' | |
|
Instances
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.
DeleteVolumeResponse' | |
|
Instances
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:
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.