LISTLOCATIONS()`¶

About ListLocations¶

Lists all custom and Amazon Web Services locations where Amazon GameLift Servers can host game servers.

Note that if you call this API using a location that doesn't have a service endpoint, such as one that can only be a remote location in a multi-location fleet, the API returns an error.

Consult the table of supported locations in Amazon GameLift Servers service locations to identify home Regions that support single and multi-location fleets.

Learn more

Service locations

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_GMLLOCFILTERLIST_W=>TT_LOCATIONFILTERLIST` `TT_LOCATIONFILTERLIST`¶

Filters the list for AWS or CUSTOM locations. Use this parameter to narrow down results to only Amazon Web Services-managed locations (Amazon EC2 or container) or only your custom locations (such as an Amazon GameLift Servers Anywhere fleet).

`iv_limit` `TYPE /AWS1/GMLLISTLOCATIONSLIMIT` `/AWS1/GMLLISTLOCATIONSLIMIT`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

`iv_nexttoken` `TYPE /AWS1/GMLNONZEROANDMAXSTRING` `/AWS1/GMLNONZEROANDMAXSTRING`¶

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmllistlocsoutput` `/AWS1/CL_GMLLISTLOCSOUTPUT`¶

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_gml~listlocations(
  it_filters = VALUE /aws1/cl_gmllocfilterlist_w=>tt_locationfilterlist(
    ( new /aws1/cl_gmllocfilterlist_w( |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_locations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_locationstringmodel = lo_row_1->get_locationname( ).
      lv_locationarnmodel = lo_row_1->get_locationarn( ).
      lo_pingbeacon = lo_row_1->get_pingbeacon( ).
      IF lo_pingbeacon IS NOT INITIAL.
        lo_udpendpoint = lo_pingbeacon->get_udpendpoint( ).
        IF lo_udpendpoint IS NOT INITIAL.
          lv_nonzeroandmaxstring = lo_udpendpoint->get_domain( ).
          lv_positiveinteger = lo_udpendpoint->get_port( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nonzeroandmaxstring = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/CL_GML=>LISTLOCATIONS()¶