LISTWORKSPACES()`¶

About ListWorkspaces¶

Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.

Method Signature¶

METHODS /AWS1/IF_IOS~LISTWORKSPACES
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/IOSNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslistwkspsresponse
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/IOSNEXTTOKEN` `/AWS1/IOSNEXTTOKEN`¶

The token to be used for the next set of paginated results.

`iv_maxresults` `TYPE /AWS1/IOSMAXRESULTS` `/AWS1/IOSMAXRESULTS`¶

The maximum number of results to return for each paginated request. Default: 50.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioslistwkspsresponse` `/AWS1/CL_IOSLISTWKSPSRESPONSE`¶

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->listworkspaces(
  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_workspacesummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_workspacename = lo_row_1->get_name( ).
      lv_arn = lo_row_1->get_arn( ).
      lo_workspacestatus = lo_row_1->get_status( ).
      IF lo_workspacestatus IS NOT INITIAL.
        lv_workspacestate = lo_workspacestatus->get_state( ).
        lo_workspaceerrordetails = lo_workspacestatus->get_error( ).
        IF lo_workspaceerrordetails IS NOT INITIAL.
          lv_errorcode = lo_workspaceerrordetails->get_code( ).
          lv_description = lo_workspaceerrordetails->get_message( ).
        ENDIF.
      ENDIF.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOS=>LISTWORKSPACES()¶