Adds a player to a game session and creates a player session record. Before a player
can be added, a game session must have an
ACTIVE status, have a creation
ALLOW_ALL, and have an open player slot. To add a group of
players to a game session, use CreatePlayerSessions.
To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
Player-session-related operations include:
Game session placements
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.
public virtual Task<CreatePlayerSessionResponse> CreatePlayerSessionAsync( String gameSessionId, String playerId, CancellationToken cancellationToken )
Unique identifier for the game session to add a player to.
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.
|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||A service resource associated with the request could not be found. Clients should not retry such requests.|
|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.|
Supported in: 1.3
Supported in: 4.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms