amazonka-efs-2.0: Amazon Elastic File System SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EFS.DeleteFileSystem

Description

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. 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 file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

Synopsis

Creating a Request

data DeleteFileSystem Source #

See: newDeleteFileSystem smart constructor.

Constructors

DeleteFileSystem' 

Fields

Instances

Instances details
ToHeaders DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

ToPath DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

ToQuery DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

AWSRequest DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Associated Types

type AWSResponse DeleteFileSystem #

Generic DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Associated Types

type Rep DeleteFileSystem :: Type -> Type #

Read DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Show DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

NFData DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Methods

rnf :: DeleteFileSystem -> () #

Eq DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Hashable DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

type AWSResponse DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

type Rep DeleteFileSystem Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

type Rep DeleteFileSystem = D1 ('MetaData "DeleteFileSystem" "Amazonka.EFS.DeleteFileSystem" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "DeleteFileSystem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteFileSystem Source #

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:

DeleteFileSystem, deleteFileSystem_fileSystemId - The ID of the file system you want to delete.

Request Lenses

deleteFileSystem_fileSystemId :: Lens' DeleteFileSystem Text Source #

The ID of the file system you want to delete.

Destructuring the Response

data DeleteFileSystemResponse Source #

See: newDeleteFileSystemResponse smart constructor.

Instances

Instances details
Generic DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Associated Types

type Rep DeleteFileSystemResponse :: Type -> Type #

Read DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Show DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

NFData DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

Eq DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

type Rep DeleteFileSystemResponse Source # 
Instance details

Defined in Amazonka.EFS.DeleteFileSystem

type Rep DeleteFileSystemResponse = D1 ('MetaData "DeleteFileSystemResponse" "Amazonka.EFS.DeleteFileSystem" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "DeleteFileSystemResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteFileSystemResponse :: DeleteFileSystemResponse Source #

Create a value of DeleteFileSystemResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.