Skip to content

/AWS1/IF_WSI=>LISTWORKSPACEINSTANCES()

About ListWorkspaceInstances

Retrieves a collection of WorkSpaces Instances based on specified filters.

Method Signature

IMPORTING

Optional arguments:

it_provisionstates TYPE /AWS1/CL_WSIPROVISIONSTATES_W=>TT_PROVISIONSTATES TT_PROVISIONSTATES

Filter WorkSpaces Instances by their current provisioning states.

iv_maxresults TYPE /AWS1/WSIMAXRESULTS /AWS1/WSIMAXRESULTS

Maximum number of WorkSpaces Instances to return in a single response.

iv_nexttoken TYPE /AWS1/WSINEXTTOKEN /AWS1/WSINEXTTOKEN

Pagination token for retrieving subsequent pages of WorkSpaces Instances.

RETURNING

oo_output TYPE REF TO /aws1/cl_wsilstworkspaceinst01 /AWS1/CL_WSILSTWORKSPACEINST01

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->/aws1/if_wsi~listworkspaceinstances(
  it_provisionstates = VALUE /aws1/cl_wsiprovisionstates_w=>tt_provisionstates(
    ( new /aws1/cl_wsiprovisionstates_w( |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_workspaceinstances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_provisionstateenum = lo_row_1->get_provisionstate( ).
      lv_workspaceinstanceid = lo_row_1->get_workspaceinstanceid( ).
      lo_ec2managedinstance = lo_row_1->get_ec2managedinstance( ).
      IF lo_ec2managedinstance IS NOT INITIAL.
        lv_string = lo_ec2managedinstance->get_instanceid( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.