DESCRIBECONNECTIONALIASES()`¶

About DescribeConnectionAliases¶

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Method Signature¶

METHODS /AWS1/IF_WSP~DESCRIBECONNECTIONALIASES
  IMPORTING
    !IT_ALIASIDS TYPE /AWS1/CL_WSPCONNALIASIDLIST_W=>TT_CONNECTIONALIASIDLIST OPTIONAL
    !IV_RESOURCEID TYPE /AWS1/WSPNONEMPTYSTRING OPTIONAL
    !IV_LIMIT TYPE /AWS1/WSPLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/WSPPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wspdsccxnaliasesrs
  RAISING
    /AWS1/CX_WSPACCESSDENIEDEX
    /AWS1/CX_WSPINVPARAMVALUESEX
    /AWS1/CX_WSPOPNOTSUPPORTEDEX
    /AWS1/CX_WSPCLIENTEXC
    /AWS1/CX_WSPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_aliasids` `TYPE /AWS1/CL_WSPCONNALIASIDLIST_W=>TT_CONNECTIONALIASIDLIST` `TT_CONNECTIONALIASIDLIST`¶

The identifiers of the connection aliases to describe.

`iv_resourceid` `TYPE /AWS1/WSPNONEMPTYSTRING` `/AWS1/WSPNONEMPTYSTRING`¶

The identifier of the directory associated with the connection alias.

`iv_limit` `TYPE /AWS1/WSPLIMIT` `/AWS1/WSPLIMIT`¶

The maximum number of connection aliases to return.

`iv_nexttoken` `TYPE /AWS1/WSPPAGINATIONTOKEN` `/AWS1/WSPPAGINATIONTOKEN`¶

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wspdsccxnaliasesrs` `/AWS1/CL_WSPDSCCXNALIASESRS`¶

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->describeconnectionaliases(
  it_aliasids = VALUE /aws1/cl_wspconnaliasidlist_w=>tt_connectionaliasidlist(
    ( new /aws1/cl_wspconnaliasidlist_w( |string| ) )
  )
  iv_limit = 123
  iv_nexttoken = |string|
  iv_resourceid = |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_connectionaliases( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_connectionstring = lo_row_1->get_connectionstring( ).
      lv_connectionaliasid = lo_row_1->get_aliasid( ).
      lv_connectionaliasstate = lo_row_1->get_state( ).
      lv_awsaccount = lo_row_1->get_owneraccountid( ).
      LOOP AT lo_row_1->get_associations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_associationstatus = lo_row_3->get_associationstatus( ).
          lv_awsaccount = lo_row_3->get_associatedaccountid( ).
          lv_nonemptystring = lo_row_3->get_resourceid( ).
          lv_connectionidentifier = lo_row_3->get_connectionidentifier( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_WSP=>DESCRIBECONNECTIONALIASES()¶