DESCRIBEGAMESESSIONPLACEMENT()`¶

About DescribeGameSessionPlacement¶

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_placementid` `TYPE /AWS1/GMLIDSTRINGMODEL` `/AWS1/GMLIDSTRINGMODEL`¶

A unique identifier for a game session placement to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldscgamesessplcout` `/AWS1/CL_GMLDSCGAMESESSPLCOUT`¶

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~describegamesessionplacement( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_gamesessionplacement = lo_result->get_gamesessionplacement( ).
  IF lo_gamesessionplacement IS NOT INITIAL.
    lv_idstringmodel = lo_gamesessionplacement->get_placementid( ).
    lv_gamesessionqueuename = lo_gamesessionplacement->get_gamesessionqueuename( ).
    lv_gamesessionplacementsta = lo_gamesessionplacement->get_status( ).
    LOOP AT lo_gamesessionplacement->get_gameproperties( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_gamepropertykey = lo_row_1->get_key( ).
        lv_gamepropertyvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_wholenumber = lo_gamesessionplacement->get_maxplayersessioncount( ).
    lv_nonzeroandmaxstring = lo_gamesessionplacement->get_gamesessionname( ).
    lv_nonzeroandmaxstring = lo_gamesessionplacement->get_gamesessionid( ).
    lv_nonzeroandmaxstring = lo_gamesessionplacement->get_gamesessionarn( ).
    lv_nonzeroandmaxstring = lo_gamesessionplacement->get_gamesessionregion( ).
    LOOP AT lo_gamesessionplacement->get_playerlatencies( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_playerid = lo_row_3->get_playerid( ).
        lv_nonzeroandmaxstring = lo_row_3->get_regionidentifier( ).
        lv_float = lo_row_3->get_latencyinmilliseconds( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_gamesessionplacement->get_starttime( ).
    lv_timestamp = lo_gamesessionplacement->get_endtime( ).
    lv_ipaddress = lo_gamesessionplacement->get_ipaddress( ).
    lv_dnsname = lo_gamesessionplacement->get_dnsname( ).
    lv_portnumber = lo_gamesessionplacement->get_port( ).
    LOOP AT lo_gamesessionplacement->get_placedplayersessions( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_playerid = lo_row_5->get_playerid( ).
        lv_playersessionid = lo_row_5->get_playersessionid( ).
      ENDIF.
    ENDLOOP.
    lv_largegamesessiondata = lo_gamesessionplacement->get_gamesessiondata( ).
    lv_matchmakerdata = lo_gamesessionplacement->get_matchmakerdata( ).
    lo_priorityconfigurationov = lo_gamesessionplacement->get_priorityconfoverride( ).
    IF lo_priorityconfigurationov IS NOT INITIAL.
      lv_placementfallbackstrate = lo_priorityconfigurationov->get_plcmtfallbackstrategy( ).
      LOOP AT lo_priorityconfigurationov->get_locationorder( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_locationstringmodel = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/CL_GML=>DESCRIBEGAMESESSIONPLACEMENT()¶