DESCRIBEWORKSPACESPOOLS()`¶

About DescribeWorkspacesPools¶

Describes the specified WorkSpaces Pools.

Method Signature¶

METHODS /AWS1/IF_WSP~DESCRIBEWORKSPACESPOOLS
  IMPORTING
    !IT_POOLIDS TYPE /AWS1/CL_WSPWORKSPACESPOOLID00=>TT_WORKSPACESPOOLIDS OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_WSPDSCWORKSPACESPOO01=>TT_DESCRWORKSPACESPOOLSFILTERS OPTIONAL
    !IV_LIMIT TYPE /AWS1/WSPLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/WSPPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wspdscworkspacespoo03
  RAISING
    /AWS1/CX_WSPACCESSDENIEDEX
    /AWS1/CX_WSPINVPARAMVALUESEX
    /AWS1/CX_WSPRESOURCENOTFOUNDEX
    /AWS1/CX_WSPCLIENTEXC
    /AWS1/CX_WSPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_poolids` `TYPE /AWS1/CL_WSPWORKSPACESPOOLID00=>TT_WORKSPACESPOOLIDS` `TT_WORKSPACESPOOLIDS`¶

The identifier of the WorkSpaces Pools.

`it_filters` `TYPE /AWS1/CL_WSPDSCWORKSPACESPOO01=>TT_DESCRWORKSPACESPOOLSFILTERS` `TT_DESCRWORKSPACESPOOLSFILTERS`¶

The filter conditions for the WorkSpaces Pool to return.

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

The maximum number of items 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_wspdscworkspacespoo03` `/AWS1/CL_WSPDSCWORKSPACESPOO03`¶

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->describeworkspacespools(
  it_filters = VALUE /aws1/cl_wspdscworkspacespoo01=>tt_descrworkspacespoolsfilters(
    (
      new /aws1/cl_wspdscworkspacespoo01(
        it_values = VALUE /aws1/cl_wspdscworkspacespoo02=>tt_dscworkspacespoolsfiltvals(
          ( new /aws1/cl_wspdscworkspacespoo02( |string| ) )
        )
        iv_name = |string|
        iv_operator = |string|
      )
    )
  )
  it_poolids = VALUE /aws1/cl_wspworkspacespoolid00=>tt_workspacespoolids(
    ( new /aws1/cl_wspworkspacespoolid00( |string| ) )
  )
  iv_limit = 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_workspacespools( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_workspacespoolid = lo_row_1->get_poolid( ).
      lv_arn = lo_row_1->get_poolarn( ).
      lo_capacitystatus = lo_row_1->get_capacitystatus( ).
      IF lo_capacitystatus IS NOT INITIAL.
        lv_availableusersessions = lo_capacitystatus->get_availableusersessions( ).
        lv_desiredusersessions = lo_capacitystatus->get_desiredusersessions( ).
        lv_actualusersessions = lo_capacitystatus->get_actualusersessions( ).
        lv_activeusersessions = lo_capacitystatus->get_activeusersessions( ).
      ENDIF.
      lv_workspacespoolname = lo_row_1->get_poolname( ).
      lv_updatedescription = lo_row_1->get_description( ).
      lv_workspacespoolstate = lo_row_1->get_state( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_bundleid = lo_row_1->get_bundleid( ).
      lv_directoryid = lo_row_1->get_directoryid( ).
      LOOP AT lo_row_1->get_errors( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_workspacespoolerrorcode = lo_row_3->get_errorcode( ).
          lv_errormessage = lo_row_3->get_errormessage( ).
        ENDIF.
      ENDLOOP.
      lo_applicationsettingsresp = lo_row_1->get_applicationsettings( ).
      IF lo_applicationsettingsresp IS NOT INITIAL.
        lv_applicationsettingsstat = lo_applicationsettingsresp->get_status( ).
        lv_settingsgroup = lo_applicationsettingsresp->get_settingsgroup( ).
        lv_s3bucketname = lo_applicationsettingsresp->get_s3bucketname( ).
      ENDIF.
      lo_timeoutsettings = lo_row_1->get_timeoutsettings( ).
      IF lo_timeoutsettings IS NOT INITIAL.
        lv_disconnecttimeoutinseco = lo_timeoutsettings->get_discncttimeoutinseconds( ).
        lv_idledisconnecttimeoutin = lo_timeoutsettings->get_idlediscncttmoutinsecs( ).
        lv_maxuserdurationinsecond = lo_timeoutsettings->get_maxuserdurationinseconds( ).
      ENDIF.
      lv_poolsrunningmode = lo_row_1->get_runningmode( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_WSP=>DESCRIBEWORKSPACESPOOLS()¶