DESCRIBEFILESYSTEMALIASES()`¶

About DescribeFileSystemAliases¶

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.

Method Signature¶

METHODS /AWS1/IF_FSX~DESCRIBEFILESYSTEMALIASES
  IMPORTING
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/FSXCLIENTREQUESTTOKEN OPTIONAL
    !IV_FILESYSTEMID TYPE /AWS1/FSXFILESYSTEMID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FSXMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FSXNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fsxdscfilesystemali01
  RAISING
    /AWS1/CX_FSXBADREQUEST
    /AWS1/CX_FSXFILESYSTEMNOTFOUND
    /AWS1/CX_FSXINTERNALSERVERERR
    /AWS1/CX_FSXCLIENTEXC
    /AWS1/CX_FSXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_filesystemid` `TYPE /AWS1/FSXFILESYSTEMID` `/AWS1/FSXFILESYSTEMID`¶

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

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/FSXCLIENTREQUESTTOKEN` `/AWS1/FSXCLIENTREQUESTTOKEN`¶

ClientRequestToken

`iv_maxresults` `TYPE /AWS1/FSXMAXRESULTS` `/AWS1/FSXMAXRESULTS`¶

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.

`iv_nexttoken` `TYPE /AWS1/FSXNEXTTOKEN` `/AWS1/FSXNEXTTOKEN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fsxdscfilesystemali01` `/AWS1/CL_FSXDSCFILESYSTEMALI01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describefilesystemaliases(
  iv_clientrequesttoken = |string|
  iv_filesystemid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_aliases( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_alternatednsname = lo_row_1->get_name( ).
      lv_aliaslifecycle = lo_row_1->get_lifecycle( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_FSX=>DESCRIBEFILESYSTEMALIASES()¶