LISTAPPLICATIONS()`¶

About ListApplications¶

Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.

Method Signature¶

METHODS /AWS1/IF_GMZ~LISTAPPLICATIONS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/GMZNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/GMZMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmzlstapplicationsout
  RAISING
    /AWS1/CX_GMZACCESSDENIEDEX
    /AWS1/CX_GMZINTERNALSERVEREX
    /AWS1/CX_GMZTHROTTLINGEX
    /AWS1/CX_GMZVALIDATIONEX
    /AWS1/CX_GMZCLIENTEXC
    /AWS1/CX_GMZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/GMZNEXTTOKEN` `/AWS1/GMZNEXTTOKEN`¶

The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

`iv_maxresults` `TYPE /AWS1/GMZMAXRESULTS` `/AWS1/GMZMAXRESULTS`¶

The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmzlstapplicationsout` `/AWS1/CL_GMZLSTAPPLICATIONSOUT`¶

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->listapplications(
  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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_identifier = lo_row_1->get_arn( ).
      lv_id = lo_row_1->get_id( ).
      lv_description = lo_row_1->get_description( ).
      lv_applicationstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_lastupdatedat( ).
      lo_runtimeenvironment = lo_row_1->get_runtimeenvironment( ).
      IF lo_runtimeenvironment IS NOT INITIAL.
        lv_runtimeenvironmenttype = lo_runtimeenvironment->get_type( ).
        lv_runtimeenvironmentversi = lo_runtimeenvironment->get_version( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GMZ=>LISTAPPLICATIONS()¶