ClaimGameServer (smaws-clients.Smaws_Client

Module Smaws_Client_GameLift.ClaimGameServer

This API works with the following fleet types: EC2 (FleetIQ)

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 Servers 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 Servers 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

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `ConflictException of Types.conflict_exception
  | `InternalServiceException of Types.internal_service_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `NotFoundException of Types.not_found_exception
  | `OutOfCapacityException of Types.out_of_capacity_exception
  | `UnauthorizedException of Types.unauthorized_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.claim_game_server_input ->
  (Types.claim_game_server_output,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `ConflictException of Types.conflict_exception
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `OutOfCapacityException of Types.out_of_capacity_exception
    | `UnauthorizedException of Types.unauthorized_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.claim_game_server_input ->
  (Types.claim_game_server_output Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `ConflictException of Types.conflict_exception
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `OutOfCapacityException of Types.out_of_capacity_exception
    | `UnauthorizedException of Types.unauthorized_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result