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 a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all
the volumes and storage virtual machines (SVMs) on the file system. Then
provide a FileSystemId
value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem
operation returns while the file system has the
DELETING
status. You can check the file system deletion status by
calling the
DescribeFileSystems
operation, which returns a list of file systems in your account. If you
pass the file system ID for a deleted file system, the
DescribeFileSystems
operation returns a FileSystemNotFound
error.
If a data repository task is in a PENDING
or EXECUTING
state,
deleting an Amazon FSx for Lustre file system will fail with an HTTP
status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
Synopsis
- data DeleteFileSystem = DeleteFileSystem' {}
- newDeleteFileSystem :: Text -> DeleteFileSystem
- deleteFileSystem_clientRequestToken :: Lens' DeleteFileSystem (Maybe Text)
- deleteFileSystem_lustreConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemLustreConfiguration)
- deleteFileSystem_openZFSConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemOpenZFSConfiguration)
- deleteFileSystem_windowsConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemWindowsConfiguration)
- deleteFileSystem_fileSystemId :: Lens' DeleteFileSystem Text
- data DeleteFileSystemResponse = DeleteFileSystemResponse' {}
- newDeleteFileSystemResponse :: Int -> DeleteFileSystemResponse
- deleteFileSystemResponse_fileSystemId :: Lens' DeleteFileSystemResponse (Maybe Text)
- deleteFileSystemResponse_lifecycle :: Lens' DeleteFileSystemResponse (Maybe FileSystemLifecycle)
- deleteFileSystemResponse_lustreResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemLustreResponse)
- deleteFileSystemResponse_openZFSResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemOpenZFSResponse)
- deleteFileSystemResponse_windowsResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemWindowsResponse)
- deleteFileSystemResponse_httpStatus :: Lens' DeleteFileSystemResponse Int
Creating a Request
data DeleteFileSystem Source #
The request object for DeleteFileSystem
operation.
See: newDeleteFileSystem
smart constructor.
DeleteFileSystem' | |
|
Instances
Create a value of DeleteFileSystem
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:DeleteFileSystem'
, deleteFileSystem_clientRequestToken
- A string of up to 64 ASCII characters that Amazon FSx uses to ensure
idempotent deletion. This token is automatically filled on your behalf
when using the Command Line Interface (CLI) or an Amazon Web Services
SDK.
DeleteFileSystem
, deleteFileSystem_lustreConfiguration
- Undocumented member.
DeleteFileSystem
, deleteFileSystem_openZFSConfiguration
- The configuration object for the OpenZFS file system used in the
DeleteFileSystem
operation.
DeleteFileSystem
, deleteFileSystem_windowsConfiguration
- Undocumented member.
DeleteFileSystem
, deleteFileSystem_fileSystemId
- The ID of the file system that you want to delete.
Request Lenses
deleteFileSystem_clientRequestToken :: Lens' DeleteFileSystem (Maybe Text) Source #
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
deleteFileSystem_lustreConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemLustreConfiguration) Source #
Undocumented member.
deleteFileSystem_openZFSConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemOpenZFSConfiguration) Source #
The configuration object for the OpenZFS file system used in the
DeleteFileSystem
operation.
deleteFileSystem_windowsConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemWindowsConfiguration) Source #
Undocumented member.
deleteFileSystem_fileSystemId :: Lens' DeleteFileSystem Text Source #
The ID of the file system that you want to delete.
Destructuring the Response
data DeleteFileSystemResponse Source #
The response object for the DeleteFileSystem
operation.
See: newDeleteFileSystemResponse
smart constructor.
DeleteFileSystemResponse' | |
|
Instances
newDeleteFileSystemResponse Source #
Create a value of DeleteFileSystemResponse
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:
DeleteFileSystem
, deleteFileSystemResponse_fileSystemId
- The ID of the file system that's being deleted.
DeleteFileSystemResponse
, deleteFileSystemResponse_lifecycle
- The file system lifecycle for the deletion request. If the
DeleteFileSystem
operation is successful, this status is DELETING
.
$sel:lustreResponse:DeleteFileSystemResponse'
, deleteFileSystemResponse_lustreResponse
- Undocumented member.
$sel:openZFSResponse:DeleteFileSystemResponse'
, deleteFileSystemResponse_openZFSResponse
- The response object for the OpenZFS file system that's being deleted in
the DeleteFileSystem
operation.
$sel:windowsResponse:DeleteFileSystemResponse'
, deleteFileSystemResponse_windowsResponse
- Undocumented member.
$sel:httpStatus:DeleteFileSystemResponse'
, deleteFileSystemResponse_httpStatus
- The response's http status code.
Response Lenses
deleteFileSystemResponse_fileSystemId :: Lens' DeleteFileSystemResponse (Maybe Text) Source #
The ID of the file system that's being deleted.
deleteFileSystemResponse_lifecycle :: Lens' DeleteFileSystemResponse (Maybe FileSystemLifecycle) Source #
The file system lifecycle for the deletion request. If the
DeleteFileSystem
operation is successful, this status is DELETING
.
deleteFileSystemResponse_lustreResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemLustreResponse) Source #
Undocumented member.
deleteFileSystemResponse_openZFSResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemOpenZFSResponse) Source #
The response object for the OpenZFS file system that's being deleted in
the DeleteFileSystem
operation.
deleteFileSystemResponse_windowsResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemWindowsResponse) Source #
Undocumented member.
deleteFileSystemResponse_httpStatus :: Lens' DeleteFileSystemResponse Int Source #
The response's http status code.