Skip to content

/AWS1/CL_GML=>UPDATEGAMESERVER()

About UpdateGameServer

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

  • To update the game server's utilization status from AVAILABLE (when the game server is available to be claimed) to UTILIZED (when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from to UTILIZED to AVAILABLE .

  • To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.

  • To change game server metadata, provide updated game server data.

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

Amazon GameLift FleetIQ Guide

Method Signature

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 to update.

Optional arguments:

IV_GAMESERVERDATA TYPE /AWS1/GMLGAMESERVERDATA /AWS1/GMLGAMESERVERDATA

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

IV_UTILIZATIONSTATUS TYPE /AWS1/GMLGAMESERVERUTILIZATI00 /AWS1/GMLGAMESERVERUTILIZATI00

Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

IV_HEALTHCHECK TYPE /AWS1/GMLGAMESERVERHEALTHCHECK /AWS1/GMLGAMESERVERHEALTHCHECK

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLUPDGAMESERVEROUT /AWS1/CL_GMLUPDGAMESERVEROUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC