DESCRIBEGAMESERVER()`¶

About DescribeGameServer¶

This API works with the following fleet types: EC2 (FleetIQ)

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Amazon GameLift Servers FleetIQ Guide

Method Signature¶

METHODS /AWS1/IF_GML~DESCRIBEGAMESERVER
  IMPORTING
    !IV_GAMESERVERGROUPNAME TYPE /AWS1/GMLGAMESERVERGRNAMEORARN OPTIONAL
    !IV_GAMESERVERID TYPE /AWS1/GMLGAMESERVERID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldescrgameserverout
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_gameservergroupname` `TYPE /AWS1/GMLGAMESERVERGRNAMEORARN` `/AWS1/GMLGAMESERVERGRNAMEORARN`¶

A unique identifier for the game server group where the game server is running.

`iv_gameserverid` `TYPE /AWS1/GMLGAMESERVERID` `/AWS1/GMLGAMESERVERID`¶

A custom string that uniquely identifies the game server information to be retrieved.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldescrgameserverout` `/AWS1/CL_GMLDESCRGAMESERVEROUT`¶

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->describegameserver(
  iv_gameservergroupname = |string|
  iv_gameserverid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_gameserver = lo_result->get_gameserver( ).
  IF lo_gameserver IS NOT INITIAL.
    lv_gameservergroupname = lo_gameserver->get_gameservergroupname( ).
    lv_gameservergrouparn = lo_gameserver->get_gameservergrouparn( ).
    lv_gameserverid = lo_gameserver->get_gameserverid( ).
    lv_gameserverinstanceid = lo_gameserver->get_instanceid( ).
    lv_gameserverconnectioninf = lo_gameserver->get_connectioninfo( ).
    lv_gameserverdata = lo_gameserver->get_gameserverdata( ).
    lv_gameserverclaimstatus = lo_gameserver->get_claimstatus( ).
    lv_gameserverutilizationst = lo_gameserver->get_utilizationstatus( ).
    lv_timestamp = lo_gameserver->get_registrationtime( ).
    lv_timestamp = lo_gameserver->get_lastclaimtime( ).
    lv_timestamp = lo_gameserver->get_lasthealthchecktime( ).
  ENDIF.
ENDIF.

/AWS1/IF_GML=>DESCRIBEGAMESERVER()¶