DisassociateFileSystemAliases - Amazon FSx

DisassociateFileSystemAliases

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 a 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 DescribeFileSystemAliases API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

Request Syntax

{ "Aliases": [ "string" ], "ClientRequestToken": "string", "FileSystemId": "string" }

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.

Aliases

An array of one or more DNS alias names to disassociate, or remove, from the file system.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 4. Maximum length of 253.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{4,253}$

Required: Yes

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use 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

Specifies the file system from which to disassociate the DNS aliases.

Type: String

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

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

Required: Yes

Response Syntax

{ "Aliases": [ { "Lifecycle": "string", "Name": "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.

Aliases

An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.

Type: Array of Alias objects

Array Members: Maximum number of 50 items.

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

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

See Also

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