claim-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.
Locates an available game server and temporarily reserves it to host gameplay and players. This action is called by a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ searches for an available game server in the specified game server group, places the game server in “claimed” status for 60 seconds, and returns connection information back to the requester so that players can connect to the game server.
There are two ways you can claim a game server. For the first option, you provide a game server group ID only, which prompts GameLift FleetIQ to search for an available game server in the specified group and claim it. With this option, GameLift FleetIQ attempts to consolidate gameplay on as few instances as possible to minimize hosting costs. For the second option, you request a specific game server by its ID. This option results in a less efficient claiming process because it does not take advantage of consolidation and may fail if the requested game server is unavailable.
To claim a game server, identify a game server group and (optionally) a game server ID. If your game requires that game data be provided to the game server at the start of a game, such as a game map or player information, you can provide it in your claim request.
When a game server is successfully claimed, connection information is returned. A claimed game server’s utilization status remains AVAILABLE, while the claim status is set to CLAIMED for up to 60 seconds. This time period allows the game server to be prompted to update its status to UTILIZED (using UpdateGameServer ). If the game server’s status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request.
If you try to claim a specific game server, this request will fail in the following cases: (1) if the game server utilization status is UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if the instance that the game server is running on is flagged as draining.
RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
claim-game-server
--game-server-group-name <value>
[--game-server-id <value>]
[--game-server-data <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. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.
--game-server-id (string)
A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.
--game-server-data (string)
A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
--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 claimed 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.