Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1441397379.2 KB

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 <a>AdministrativeAction</a> provided in the <a>DescribeFileSystems</a> operation response.

post/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileSystemAliases

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'AWSSimbaAPIService_v20180301.DescribeFileSystemAliases' required

Request body

ClientRequestTokenstring

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

FileSystemIdstring required

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

MaxResultsinteger

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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.

NextTokenstring

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

Response

Success

NextTokenstring

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