| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Lightsail.DeleteDisk
Description
Deletes the specified block storage disk. The disk must be in the
available state (not attached to a Lightsail instance).
The disk may remain in the deleting state for several minutes.
The delete disk operation supports tag-based access control via
resource tags applied to the resource identified by disk name. For
more information, see the
Amazon Lightsail Developer Guide.
Synopsis
- data DeleteDisk = DeleteDisk' {}
- newDeleteDisk :: Text -> DeleteDisk
- deleteDisk_forceDeleteAddOns :: Lens' DeleteDisk (Maybe Bool)
- deleteDisk_diskName :: Lens' DeleteDisk Text
- data DeleteDiskResponse = DeleteDiskResponse' {
- operations :: Maybe [Operation]
- httpStatus :: Int
- newDeleteDiskResponse :: Int -> DeleteDiskResponse
- deleteDiskResponse_operations :: Lens' DeleteDiskResponse (Maybe [Operation])
- deleteDiskResponse_httpStatus :: Lens' DeleteDiskResponse Int
Creating a Request
data DeleteDisk Source #
See: newDeleteDisk smart constructor.
Constructors
| DeleteDisk' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteDisk |
Create a value of DeleteDisk 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:forceDeleteAddOns:DeleteDisk', deleteDisk_forceDeleteAddOns - A Boolean value to indicate whether to delete the enabled add-ons for
the disk.
$sel:diskName:DeleteDisk', deleteDisk_diskName - The unique name of the disk you want to delete (e.g., my-disk).
Request Lenses
deleteDisk_forceDeleteAddOns :: Lens' DeleteDisk (Maybe Bool) Source #
A Boolean value to indicate whether to delete the enabled add-ons for the disk.
deleteDisk_diskName :: Lens' DeleteDisk Text Source #
The unique name of the disk you want to delete (e.g., my-disk).
Destructuring the Response
data DeleteDiskResponse Source #
See: newDeleteDiskResponse smart constructor.
Constructors
| DeleteDiskResponse' | |
Fields
| |
Instances
newDeleteDiskResponse Source #
Arguments
| :: Int | |
| -> DeleteDiskResponse |
Create a value of DeleteDiskResponse 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:operations:DeleteDiskResponse', deleteDiskResponse_operations - An array of objects that describe the result of the action, such as the
status of the request, the timestamp of the request, and the resources
affected by the request.
$sel:httpStatus:DeleteDiskResponse', deleteDiskResponse_httpStatus - The response's http status code.
Response Lenses
deleteDiskResponse_operations :: Lens' DeleteDiskResponse (Maybe [Operation]) Source #
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
deleteDiskResponse_httpStatus :: Lens' DeleteDiskResponse Int Source #
The response's http status code.