paws.storage (version 0.1.12)

fsx_delete_file_system: Deletes a file system, deleting its contents

Description

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The delete_file_system action returns while the file system has the DELETING status. You can check the file system deletion status by calling the describe_file_systems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the describe_file_systems returns a FileSystemNotFound error.

Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.

The data in a deleted file system is also deleted and can't be recovered by any means.

Usage

fsx_delete_file_system(FileSystemId, ClientRequestToken,
  WindowsConfiguration, LustreConfiguration)

Value

A list with the following syntax:

list(
  FileSystemId = "string",
  Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING",
  WindowsResponse = list(
    FinalBackupId = "string",
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  ),
  LustreResponse = list(
    FinalBackupId = "string",
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Arguments

FileSystemId

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

ClientRequestToken

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

WindowsConfiguration

LustreConfiguration

Request syntax

svc$delete_file_system(
  FileSystemId = "string",
  ClientRequestToken = "string",
  WindowsConfiguration = list(
    SkipFinalBackup = TRUE|FALSE,
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  ),
  LustreConfiguration = list(
    SkipFinalBackup = TRUE|FALSE,
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Examples

if (FALSE) {
# This operation deletes an Amazon FSx file system.
svc$delete_file_system(
  FileSystemId = "fs-0498eed5fe91001ec"
)
}