Method: Aws::GameLift::Client#claim_game_server

Defined in:

lib/aws-sdk-gamelift/client.rb

#claim_game_server(params = {}) ⇒ Types::ClaimGameServerOutput

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

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in ‘CLAIMED` status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on ‘ACTIVE` instances to be claimed.

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 gives the game server time to update its status to `UTILIZED` after players join. 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 game server is running on an instance in ‘DRAINING` status and the provided filter option does not allow placing on `DRAINING` instances.

**Learn more**

Amazon GameLift FleetIQ Guide][1

[1]: docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html

Examples:

Request syntax with placeholder values

resp = client.claim_game_server({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId",
  game_server_data: "GameServerData",
  filter_option: {
    instance_statuses: ["ACTIVE"], # accepts ACTIVE, DRAINING
  },
})

Response structure

resp.game_server.game_server_group_name #=> String
resp.game_server.game_server_group_arn #=> String
resp.game_server.game_server_id #=> String
resp.game_server.instance_id #=> String
resp.game_server.connection_info #=> String
resp.game_server.game_server_data #=> String
resp.game_server.claim_status #=> String, one of "CLAIMED"
resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
resp.game_server.registration_time #=> Time
resp.game_server.last_claim_time #=> Time
resp.game_server.last_health_check_time #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :game_server_group_name (required, String) —

  A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

• :game_server_id (String) —

  A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon 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. This data is passed to a game client or service when it requests information on game servers.

• :filter_option (Types::ClaimFilterOption) —

  Object that restricts how a claimed game server is chosen.

Returns:

• (Types::ClaimGameServerOutput) —

  Returns a response object which responds to the following methods:

  • #game_server => Types::GameServer

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-gamelift/client.rb', line 594

def claim_game_server(params = {}, options = {})
  req = build_request(:claim_game_server, params)
  req.send_request(options)
end