DESCRIBEFLEETLOCATIONATTRS()`¶

About DescribeFleetLocationAttributes¶

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up Amazon GameLift Servers fleets

Amazon GameLift Servers service locations for managed hosting

Method Signature¶

METHODS /AWS1/IF_GML~DESCRIBEFLEETLOCATIONATTRS
  IMPORTING
    !IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN OPTIONAL
    !IT_LOCATIONS TYPE /AWS1/CL_GMLLOCATIONLIST_W=>TT_LOCATIONLIST OPTIONAL
    !IV_LIMIT TYPE /AWS1/GMLPOSITIVEINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldscfleetlocattrs01
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_fleetid` `TYPE /AWS1/GMLFLEETIDORARN` `/AWS1/GMLFLEETIDORARN`¶

A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

Optional arguments:¶

`it_locations` `TYPE /AWS1/CL_GMLLOCATIONLIST_W=>TT_LOCATIONLIST` `TT_LOCATIONLIST`¶

A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as us-west-2.

`iv_limit` `TYPE /AWS1/GMLPOSITIVEINTEGER` `/AWS1/GMLPOSITIVEINTEGER`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

`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_gmldscfleetlocattrs01` `/AWS1/CL_GMLDSCFLEETLOCATTRS01`¶

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->describefleetlocationattrs(
  it_locations = VALUE /aws1/cl_gmllocationlist_w=>tt_locationlist(
    ( new /aws1/cl_gmllocationlist_w( |string| ) )
  )
  iv_fleetid = |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.
  lv_fleetidorarn = lo_result->get_fleetid( ).
  lv_fleetarn = lo_result->get_fleetarn( ).
  LOOP AT lo_result->get_locationattributes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_locationstate = lo_row_1->get_locationstate( ).
      IF lo_locationstate IS NOT INITIAL.
        lv_locationstringmodel = lo_locationstate->get_location( ).
        lv_fleetstatus = lo_locationstate->get_status( ).
      ENDIF.
      LOOP AT lo_row_1->get_stoppedactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_fleetaction = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_locationupdatestatus = lo_row_1->get_updatestatus( ).
    ENDIF.
  ENDLOOP.
  lv_nonzeroandmaxstring = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GML=>DESCRIBEFLEETLOCATIONATTRS()¶