ClaimGameServer - Amazon GameLift Service

ClaimGameServer

This operation 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 operation 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. It then places the game server in CLAIMED status for 60 seconds. Finally, it returns connection information back to the requester so that players can connect to the game server.

You have two options for claiming a game server:

  • Request the best available game server. With this option, you provide a game server group ID only. This request prompts GameLift FleetIQ to search in the specified group for an available game server. GameLift FleetIQ attempts to select only from game servers that are viable for game hosting and also consolidates gameplay on as few instances as possible to optimize automatic scaling.

  • Request a specific game server. With this option, you provide a specific game server ID as well as the game server group ID. This type of request bypasses the GameLift FleetIQ placement optimization and may place new game sessions with game servers that are more likely to be interrupted. In addition, this option might fail if the requested game server is unavailable.

To claim a game server, identify a game server group and (optionally) a game server ID. Your game might require that game data be provided to the game server at the start of a game, such as a game map or player information. If so, 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. The claim time period is a fixed value and is not configurable.

If you try to claim a specific game server, this request will fail in the following cases:

  • If the game server utilization status is UTILIZED

  • If the game server claim status is CLAIMED

  • If the instance that the game server is running on is flagged as draining

Learn more

GameLift FleetIQ Guide

Related operations

Request Syntax

{ "GameServerData": "string", "GameServerGroupName": "string", "GameServerId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

GameServerGroupName

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 in. You can use either the GameServerGroup name or ARN value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9-\.]+|^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]+

Required: Yes

GameServerData

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Required: No

GameServerId

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.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: [a-zA-Z0-9-\.]+

Required: No

Response Syntax

{ "GameServer": { "ClaimStatus": "string", "ConnectionInfo": "string", "CustomSortKey": "string", "GameServerData": "string", "GameServerGroupArn": "string", "GameServerGroupName": "string", "GameServerId": "string", "InstanceId": "string", "LastClaimTime": number, "LastHealthCheckTime": number, "RegistrationTime": number, "UtilizationStatus": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GameServer

Object that describes the newly claimed game server resource.

Type: GameServer object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 400

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

OutOfCapacityException

The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

Example

Reserve a game server for a new game session

This example reserves an available game server to host a new game session. Because the request does not specify a game server ID, GameLift selects an available game server with optimal placement.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request

{ "GameServerGroupName": "MegaFrogServers_NA", "IdempotencyToken": "12345678"} CLI command: aws gamelift claim-game-server \ --game-server-group-name MegaFrogServers_NA

Sample Response

{ "GameServer": { "ClaimStatus": "CLAIMED", "ConnectionInfo": "192.0.2.0.80", "CustomSortKey": "", "GameServerData": "", "GameServerGroupArn": "arn:aws:gamelift:us-west-2::GameServerGroup/MegaFrogServers_NA", "GameServerGroupName": "MegaFrogServers_NA", "GameServerId": "mega-frog-game-12345678", "InstanceId": "i-1234567890abcdef0", "LastClaimTime": 1580218197.293, "LastHealthCheckTime": 1580218197.293, "RegistrationTime": 1580218197.293, "UtilizationStatus": "AVAILABLE" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: