| 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.StorageGateway.DeleteFileShare
Description
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
Synopsis
- data DeleteFileShare = DeleteFileShare' {
- forceDelete :: Maybe Bool
- fileShareARN :: Text
- newDeleteFileShare :: Text -> DeleteFileShare
- deleteFileShare_forceDelete :: Lens' DeleteFileShare (Maybe Bool)
- deleteFileShare_fileShareARN :: Lens' DeleteFileShare Text
- data DeleteFileShareResponse = DeleteFileShareResponse' {
- fileShareARN :: Maybe Text
- httpStatus :: Int
- newDeleteFileShareResponse :: Int -> DeleteFileShareResponse
- deleteFileShareResponse_fileShareARN :: Lens' DeleteFileShareResponse (Maybe Text)
- deleteFileShareResponse_httpStatus :: Lens' DeleteFileShareResponse Int
Creating a Request
data DeleteFileShare Source #
DeleteFileShareInput
See: newDeleteFileShare smart constructor.
Constructors
| DeleteFileShare' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteFileShare |
Create a value of DeleteFileShare 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:forceDelete:DeleteFileShare', deleteFileShare_forceDelete - If this value is set to true, the operation deletes a file share
immediately and aborts all data uploads to Amazon Web Services.
Otherwise, the file share is not deleted until all data is uploaded to
Amazon Web Services. This process aborts the data upload process, and
the file share enters the FORCE_DELETING status.
Valid Values: true | false
DeleteFileShare, deleteFileShare_fileShareARN - The Amazon Resource Name (ARN) of the file share to be deleted.
Request Lenses
deleteFileShare_forceDelete :: Lens' DeleteFileShare (Maybe Bool) Source #
If this value is set to true, the operation deletes a file share
immediately and aborts all data uploads to Amazon Web Services.
Otherwise, the file share is not deleted until all data is uploaded to
Amazon Web Services. This process aborts the data upload process, and
the file share enters the FORCE_DELETING status.
Valid Values: true | false
deleteFileShare_fileShareARN :: Lens' DeleteFileShare Text Source #
The Amazon Resource Name (ARN) of the file share to be deleted.
Destructuring the Response
data DeleteFileShareResponse Source #
DeleteFileShareOutput
See: newDeleteFileShareResponse smart constructor.
Constructors
| DeleteFileShareResponse' | |
Fields
| |
Instances
newDeleteFileShareResponse Source #
Create a value of DeleteFileShareResponse 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:
DeleteFileShare, deleteFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the deleted file share.
$sel:httpStatus:DeleteFileShareResponse', deleteFileShareResponse_httpStatus - The response's http status code.
Response Lenses
deleteFileShareResponse_fileShareARN :: Lens' DeleteFileShareResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deleted file share.
deleteFileShareResponse_httpStatus :: Lens' DeleteFileShareResponse Int Source #
The response's http status code.