AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginClaimGameServer and EndClaimGameServer.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public abstract Task<ClaimGameServerResponse> ClaimGameServerAsync( ClaimGameServerRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ClaimGameServer service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. |
| NotFoundException | The requested resources was not found. The resource was either not created yet or deleted. |
| 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. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer