DescribeFileSystemAliasesCommand

Suggest an Edit

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

Example Syntax

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

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

DescribeFileSystemAliasesCommand Input

See DescribeFileSystemAliasesCommandInput for more details

Parameter
Type
Description
FileSystemId
Required
string | undefined

The ID of the file system to return the associated DNS aliases for (String).

ClientRequestToken
string | undefined

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

MaxResults
number | undefined

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
string | undefined

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

DescribeFileSystemAliasesCommand Output

See DescribeFileSystemAliasesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Aliases
Alias[] | undefined

An array of one or more DNS aliases currently associated with the specified file system.

NextToken
string | undefined

Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

Throws

Name
Fault
Details
BadRequest
client

A generic error indicating a failure with a client request.

FileSystemNotFound
client

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

InternalServerError
server

A generic error indicating a server-side failure.

FSxServiceException
Base exception class for all service exceptions from FSx service.