DeleteFileSystem - Amazon FSx

DeleteFileSystem

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.

Note

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

Important

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

Request Syntax

{ "ClientRequestToken": "string", "FileSystemId": "string", "LustreConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean }, "OpenZFSConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "Options": [ "string" ], "SkipFinalBackup": boolean }, "WindowsConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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 AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

FileSystemId

The ID of the file system that you want to delete.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fs-[0-9a-f]{8,})$

Required: Yes

LustreConfiguration

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Type: DeleteFileSystemLustreConfiguration object

Required: No

OpenZFSConfiguration

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

Type: DeleteFileSystemOpenZFSConfiguration object

Required: No

WindowsConfiguration

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

Type: DeleteFileSystemWindowsConfiguration object

Required: No

Response Syntax

{ "FileSystemId": "string", "Lifecycle": "string", "LustreResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "OpenZFSResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "WindowsResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileSystemId

The ID of the file system that's being deleted.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fs-[0-9a-f]{8,})$

Lifecycle

The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful, this status is DELETING.

Type: String

Valid Values: AVAILABLE | CREATING | FAILED | DELETING | MISCONFIGURED | UPDATING | MISCONFIGURED_UNAVAILABLE

LustreResponse

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Type: DeleteFileSystemLustreResponse object

OpenZFSResponse

The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem operation.

Type: DeleteFileSystemOpenZFSResponse object

WindowsResponse

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

Type: DeleteFileSystemWindowsResponse object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

FileSystemNotFound

No Amazon FSx file systems were found based upon supplied parameters.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

ServiceLimitExceeded

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: