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.
Reserves an open player slot in a game session for a player. New player sessions can
be created in any game session with an open slot that is in ACTIVE status and
has a player creation policy of ACCEPT_ALL. You can add a group of players
to a game session with CreatePlayerSessions
.
To create a player session, specify a game session ID, player ID, and optionally a set of player data.
If successful, a slot is reserved in the game session for the player and a new PlayerSessions
object is returned with a player session ID. The player references the player session
ID when sending a connection request to the game session, and the game server can
use it to validate the player reservation with the Amazon GameLift service. Player
sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
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 BeginCreatePlayerSession and EndCreatePlayerSession.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public abstract Task<CreatePlayerSessionResponse> CreatePlayerSessionAsync( String gameSessionId, String playerId, CancellationToken cancellationToken )
A unique identifier for the game session to add a player to.
A unique identifier for a player. Player IDs are developer-defined.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| GameSessionFullException | The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period. |
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidGameSessionStatusException | The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying. |
| 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. |
| TerminalRoutingStrategyException | The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5