Container for the parameters to the CreatePlayerSessions operation. This API works with the following fleet types: EC2, Anywhere, Container
Reserves open slots in a game session for a group of players. 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. To add a single player to a
game session, use CreatePlayerSession
To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new PlayerSession
objects are returned with player session IDs. Each player references their 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 Servers service.
Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.CreatePlayerSessionsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class CreatePlayerSessionsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The CreatePlayerSessionsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreatePlayerSessionsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GameSessionId | System.String |
Gets and sets the property GameSessionId. A unique identifier for the game session to add players to. |
|
|
PlayerDataMap | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property PlayerDataMap.
Map of string pairs, each specifying a player ID and a set of developer-defined information
related to the player. Amazon GameLift Servers does not use this data, so it can be
formatted as needed for use in the game. Any player data strings for player IDs that
are not included in the |
|
|
PlayerIds | System.Collections.Generic.List<System.String> |
Gets and sets the property PlayerIds. List of unique identifiers for the players to be added. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer