Describe File System Aliases

fsx_describe_file_system_aliases

R Documentation

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system¶

Description¶

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 describe_file_systems operation response.

Usage¶

fsx_describe_file_system_aliases(ClientRequestToken, FileSystemId,
  MaxResults, NextToken)

Arguments¶

ClientRequestToken

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

FileSystemId

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

MaxResults

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

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

Value¶

A list with the following syntax:

list(
  Aliases = list(
    list(
      Name = "string",
      Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_file_system_aliases(
  ClientRequestToken = "string",
  FileSystemId = "string",
  MaxResults = 123,
  NextToken = "string"
)