[ aws . gamelift ]

update-game-server

Description

This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.

Updates information about a registered game server. This action is called by a game server process that is running on an instance in a game server group. There are three reasons to update game server information: (1) to change the utilization status of the game server, (2) to report game server health status, and (3) to change game server metadata. A registered game server should regularly report health and should update utilization status when it is supporting gameplay so that GameLift FleetIQ can accurately track game server availability. You can make all three types of updates in the same request.

• To update the game server’s utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.

• 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 and will be eventually de-registered 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 and custom sort key values.

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

Learn more

GameLift FleetIQ Guide

Related operations

• RegisterGameServer

• ListGameServers

• ClaimGameServer

• DescribeGameServer

• UpdateGameServer

• DeregisterGameServer

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-game-server
--game-server-group-name <value>
--game-server-id <value>
[--game-server-data <value>]
[--custom-sort-key <value>]
[--utilization-status <value>]
[--health-check <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--game-server-group-name (string)

An identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

--game-server-id (string)

The identifier for the game server to be updated.

--game-server-data (string)

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 a game servers using DescribeGameServer or ClaimGameServer .

--custom-sort-key (string)

A game server tag that can be used to request sorted lists of game servers using ListGameServers . Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.

--utilization-status (string)

Indicates whether the game server is available or is currently hosting gameplay.

Possible values:

• AVAILABLE

• UTILIZED

--health-check (string)

Indicates health status of the game server. An update that explicitly includes this parameter updates the game server’s LastHealthCheckTime time stamp.

Possible values:

• HEALTHY

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

GameServer -> (structure)

Object that describes the newly updated game server resource.

GameServerGroupName -> (string)

The name identifier for the game server group where the game server is located.

GameServerGroupArn -> (string)

The ARN identifier for the game server group where the game server is located.

GameServerId -> (string)

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

InstanceId -> (string)

The unique identifier for the instance where the game server is located.

ConnectionInfo -> (string)

The port and IP address that must be used to establish a client connection to the game server.

GameServerData -> (string)

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer . This property can be updated using UpdateGameServer .

CustomSortKey -> (string)

A game server tag that can be used to request sorted lists of game servers when calling ListGameServers . Custom sort keys are developer-defined. This property can be updated using UpdateGameServer .

ClaimStatus -> (string)

Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.

UtilizationStatus -> (string)

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• IN_USE - The game server is currently hosting a game session with players.

RegistrationTime -> (timestamp)

Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).

LastClaimTime -> (timestamp)

Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). This value is used to calculate when the game server’s claim status.

LastHealthCheckTime -> (timestamp)

Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). After game server registration, this property is only changed when a game server update specifies a health check value.