import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteFileSystemRequest, DeleteFileSystemResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DeleteFileSystemCommand}. */ export interface DeleteFileSystemCommandInput extends DeleteFileSystemRequest { } /** * @public * * The output of {@link DeleteFileSystemCommand}. */ export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse, __MetadataBearer { } declare const DeleteFileSystemCommand_base: { new (input: DeleteFileSystemCommandInput): import("@smithy/core/client").CommandImpl; new (input: DeleteFileSystemCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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 DeleteFileSystem operation.

*

Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't * any Amazon S3 access points attached to any volume. For more information on how to list S3 * access points that are attached to volumes, see * Listing S3 access point attachments. * For more information on how to delete S3 access points, see * Deleting an S3 access point attachment.

*

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.

*

To delete an Amazon FSx for Lustre file system, first * unmount * it from every connected Amazon EC2 instance, then provide a FileSystemId * value to the DeleteFileSystem operation. By default, Amazon FSx will not * take a final backup when the DeleteFileSystem operation is invoked. On file systems * not linked to an Amazon S3 bucket, set SkipFinalBackup to false * to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked * file systems. To ensure all of your data is written back to S3 before deleting your file system, * you can either monitor for the * AgeOfOldestQueuedMessage * metric to be zero (if using automatic export) or you can run an * export data repository task. * If you have automatic export enabled and want to use an export data repository task, you have * to disable automatic export before executing the export data repository task.

*

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.

* *

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

*
* *

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

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FSxClient, DeleteFileSystemCommand } from "@aws-sdk/client-fsx"; // ES Modules import * // const { FSxClient, DeleteFileSystemCommand } = require("@aws-sdk/client-fsx"); // CommonJS import * // import type { FSxClientConfig } from "@aws-sdk/client-fsx"; * const config = {}; // type is FSxClientConfig * const client = new FSxClient(config); * const input = { // DeleteFileSystemRequest * FileSystemId: "STRING_VALUE", // required * ClientRequestToken: "STRING_VALUE", * WindowsConfiguration: { // DeleteFileSystemWindowsConfiguration * SkipFinalBackup: true || false, * FinalBackupTags: [ // Tags * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * LustreConfiguration: { // DeleteFileSystemLustreConfiguration * SkipFinalBackup: true || false, * FinalBackupTags: [ * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * OpenZFSConfiguration: { // DeleteFileSystemOpenZFSConfiguration * SkipFinalBackup: true || false, * FinalBackupTags: [ * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * Options: [ // DeleteFileSystemOpenZFSOptions * "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS", * ], * }, * }; * const command = new DeleteFileSystemCommand(input); * const response = await client.send(command); * // { // DeleteFileSystemResponse * // FileSystemId: "STRING_VALUE", * // Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE", * // WindowsResponse: { // DeleteFileSystemWindowsResponse * // FinalBackupId: "STRING_VALUE", * // FinalBackupTags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // LustreResponse: { // DeleteFileSystemLustreResponse * // FinalBackupId: "STRING_VALUE", * // FinalBackupTags: [ * // { * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // OpenZFSResponse: { // DeleteFileSystemOpenZFSResponse * // FinalBackupId: "STRING_VALUE", * // FinalBackupTags: [ * // { * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // }; * * ``` * * @param DeleteFileSystemCommandInput - {@link DeleteFileSystemCommandInput} * @returns {@link DeleteFileSystemCommandOutput} * @see {@link DeleteFileSystemCommandInput} for command's `input` shape. * @see {@link DeleteFileSystemCommandOutput} for command's `response` shape. * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape. * * @throws {@link BadRequest} (client fault) *

A generic error indicating a failure with a client request.

* * @throws {@link FileSystemNotFound} (client fault) *

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

* * @throws {@link IncompatibleParameterError} (client fault) *

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.

* * @throws {@link InternalServerError} (server fault) *

A generic error indicating a server-side failure.

* * @throws {@link ServiceLimitExceeded} (client fault) *

An error indicating that a particular service limit was exceeded. You can increase * some service limits by contacting Amazon Web Services Support.

* * @throws {@link FSxServiceException} *

Base exception class for all service exceptions from FSx service.

* * * @example To delete a file system * ```javascript * // This operation deletes an Amazon FSx file system. * const input = { * FileSystemId: "fs-0498eed5fe91001ec" * }; * const command = new DeleteFileSystemCommand(input); * const response = await client.send(command); * /* response is * { * FileSystemId: "fs-0498eed5fe91001ec", * Lifecycle: "DELETING" * } * *\/ * ``` * * @public */ export declare class DeleteFileSystemCommand extends DeleteFileSystemCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteFileSystemRequest; output: DeleteFileSystemResponse; }; sdk: { input: DeleteFileSystemCommandInput; output: DeleteFileSystemCommandOutput; }; }; }