| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.GameLift.CreatePlayerSessions
Description
Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.
- createPlayerSessions :: Text -> NonEmpty Text -> CreatePlayerSessions
- data CreatePlayerSessions
- cpsGameSessionId :: Lens' CreatePlayerSessions Text
- cpsPlayerIds :: Lens' CreatePlayerSessions (NonEmpty Text)
- createPlayerSessionsResponse :: Int -> CreatePlayerSessionsResponse
- data CreatePlayerSessionsResponse
- crsPlayerSessions :: Lens' CreatePlayerSessionsResponse [PlayerSession]
- crsResponseStatus :: Lens' CreatePlayerSessionsResponse Int
Creating a Request
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> CreatePlayerSessions |
Creates a value of CreatePlayerSessions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreatePlayerSessions Source
Represents the input for a request action.
See: createPlayerSessions smart constructor.
Instances
Request Lenses
cpsGameSessionId :: Lens' CreatePlayerSessions Text Source
Unique identifier for a game session.
cpsPlayerIds :: Lens' CreatePlayerSessions (NonEmpty Text) Source
List of unique identifiers for the players to be added.
Destructuring the Response
createPlayerSessionsResponse Source
Arguments
| :: Int | |
| -> CreatePlayerSessionsResponse |
Creates a value of CreatePlayerSessionsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreatePlayerSessionsResponse Source
Represents the returned data in response to a request action.
See: createPlayerSessionsResponse smart constructor.
Response Lenses
crsPlayerSessions :: Lens' CreatePlayerSessionsResponse [PlayerSession] Source
Collection of player session objects created for the added players.
crsResponseStatus :: Lens' CreatePlayerSessionsResponse Int Source
The response status code.