Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DisassociateFileSystemAliasesCommandProtected

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see Working with DNS Aliases.

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

Example

Use a bare-bones client and the command you need to make an API call.

import { FSxClient, DisassociateFileSystemAliasesCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, DisassociateFileSystemAliasesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // DisassociateFileSystemAliasesRequest
ClientRequestToken: "STRING_VALUE",
FileSystemId: "STRING_VALUE", // required
Aliases: [ // AlternateDNSNames // required
"STRING_VALUE",
],
};
const command = new DisassociateFileSystemAliasesCommand(input);
const response = await client.send(command);
// { // DisassociateFileSystemAliasesResponse
// Aliases: [ // Aliases
// { // Alias
// Name: "STRING_VALUE",
// Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
// },
// ],
// };

Param

DisassociateFileSystemAliasesCommandInput

Returns

DisassociateFileSystemAliasesCommandOutput

See

Throws

BadRequest (client fault)

A generic error indicating a failure with a client request.

Throws

FileSystemNotFound (client fault)

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

Throws

InternalServerError (server fault)

A generic error indicating a server-side failure.

Throws

FSxServiceException

Base exception class for all service exceptions from FSx service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods