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.DeleteFileSystem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DeleteFileSystem Source #

The request object for DeleteFileSystem operation.

See: newDeleteFileSystem smart constructor.

Constructors

DeleteFileSystem'

Fields

clientRequestToken :: Maybe Text
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.
lustreConfiguration :: Maybe DeleteFileSystemLustreConfiguration
openZFSConfiguration :: Maybe DeleteFileSystemOpenZFSConfiguration
The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.
windowsConfiguration :: Maybe DeleteFileSystemWindowsConfiguration
fileSystemId :: Text
The ID of the file system that you want to delete.

Instances

Instances details

ToJSON DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods toJSON :: DeleteFileSystem -> Value # toEncoding :: DeleteFileSystem -> Encoding # toJSONList :: [DeleteFileSystem] -> Value # toEncodingList :: [DeleteFileSystem] -> Encoding #
ToHeaders DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods toHeaders :: DeleteFileSystem -> [Header] #
ToPath DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods toPath :: DeleteFileSystem -> ByteString #
ToQuery DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods toQuery :: DeleteFileSystem -> QueryString #
AWSRequest DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Associated Types type AWSResponse DeleteFileSystem # Methods request :: (Service -> Service) -> DeleteFileSystem -> Request DeleteFileSystem # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteFileSystem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteFileSystem))) #
Generic DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Associated Types type Rep DeleteFileSystem :: Type -> Type # Methods from :: DeleteFileSystem -> Rep DeleteFileSystem x # to :: Rep DeleteFileSystem x -> DeleteFileSystem #
Read DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods readsPrec :: Int -> ReadS DeleteFileSystem # readList :: ReadS [DeleteFileSystem] # readPrec :: ReadPrec DeleteFileSystem # readListPrec :: ReadPrec [DeleteFileSystem] #
Show DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods showsPrec :: Int -> DeleteFileSystem -> ShowS # show :: DeleteFileSystem -> String # showList :: [DeleteFileSystem] -> ShowS #
NFData DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods rnf :: DeleteFileSystem -> () #
Eq DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods (==) :: DeleteFileSystem -> DeleteFileSystem -> Bool # (/=) :: DeleteFileSystem -> DeleteFileSystem -> Bool #
Hashable DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem Methods hashWithSalt :: Int -> DeleteFileSystem -> Int # hash :: DeleteFileSystem -> Int #
type AWSResponse DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem type AWSResponse DeleteFileSystem = DeleteFileSystemResponse
type Rep DeleteFileSystem Source #
Instance details Defined in Amazonka.FSx.DeleteFileSystem type Rep DeleteFileSystem = D1 ('MetaData "DeleteFileSystem" "Amazonka.FSx.DeleteFileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteFileSystem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteFileSystemLustreConfiguration))) :: (S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteFileSystemOpenZFSConfiguration)) :: (S1 ('MetaSel ('Just "windowsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteFileSystemWindowsConfiguration)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDeleteFileSystem Source #

Arguments

:: Text	`DeleteFileSystem`
-> DeleteFileSystem

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.

Constructors

DeleteFileSystemResponse'

Fields

fileSystemId :: Maybe Text
The ID of the file system that's being deleted.
lifecycle :: Maybe FileSystemLifecycle
The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful, this status is DELETING.
lustreResponse :: Maybe DeleteFileSystemLustreResponse
openZFSResponse :: Maybe DeleteFileSystemOpenZFSResponse
The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem operation.
windowsResponse :: Maybe DeleteFileSystemWindowsResponse
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDeleteFileSystemResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteFileSystemResponse'`
-> DeleteFileSystemResponse

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.