Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . fsx ]

delete-file-system

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 DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

Warning

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-file-system
--file-system-id <value>
[--client-request-token <value>]
[--windows-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--file-system-id (string)

The ID of the file system you want to delete.

--client-request-token (string)

(Optional) 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.

--windows-configuration (structure)

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Shorthand Syntax:

SkipFinalBackup=boolean,FinalBackupTags=[{Key=string,Value=string},{Key=string,Value=string}]

JSON Syntax:

{
  "SkipFinalBackup": true|false,
  "FinalBackupTags": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FileSystemId -> (string)

The ID of the file system being deleted.

Lifecycle -> (string)

The file system lifecycle for the deletion request. Should be DELETING .

WindowsResponse -> (structure)

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

FinalBackupId -> (string)

The ID of the final backup for this file system.

FinalBackupTags -> (list)

The set of tags applied to the final backup.

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .