paws.storage (version 0.1.12)

efs_delete_file_system: Deletes a file system, permanently severing access to its contents

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 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 describe_mount_targets and delete_mount_target.

The delete_file_system call returns while the file system state is still deleting. You can check the file system deletion status by calling the describe_file_systems 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 describe_file_systems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

Usage

efs_delete_file_system(FileSystemId)

Value

An empty list.

Arguments

FileSystemId

[required] The ID of the file system you want to delete.

Request syntax

svc$delete_file_system(
  FileSystemId = "string"
)

Examples

if (FALSE) {
# This operation deletes an EFS file system.
svc$delete_file_system(
  FileSystemId = "fs-01234567"
)
}