/AWS1/CL_RBM=>LISTWORLDS()

About ListWorlds

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

Lists worlds.

Method Signature

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/RBMPAGINATIONTOKEN /AWS1/RBMPAGINATIONTOKEN

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

iv_maxresults TYPE /AWS1/RBMMAXRESULTS /AWS1/RBMMAXRESULTS

When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

it_filters TYPE /AWS1/CL_RBMFILTER=>TT_FILTERS TT_FILTERS

Optional filters to limit results. You can use status.

RETURNING

oo_output TYPE REF TO /aws1/cl_rbmlistworldsresponse /AWS1/CL_RBMLISTWORLDSRESPONSE

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_rbm~listworlds(
  it_filters = VALUE /aws1/cl_rbmfilter=>tt_filters(
    (
      new /aws1/cl_rbmfilter(
        it_values = VALUE /aws1/cl_rbmfiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_rbmfiltervalues_w( |string| ) )
        )
        iv_name = |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_worldsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_arn = lo_row_1->get_generationjob( ).
      lv_arn = lo_row_1->get_template( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.