| 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.UpdateGameSession
Description
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
- updateGameSession :: Text -> UpdateGameSession
- data UpdateGameSession
- ugsMaximumPlayerSessionCount :: Lens' UpdateGameSession (Maybe Natural)
- ugsPlayerSessionCreationPolicy :: Lens' UpdateGameSession (Maybe PlayerSessionCreationPolicy)
- ugsName :: Lens' UpdateGameSession (Maybe Text)
- ugsProtectionPolicy :: Lens' UpdateGameSession (Maybe ProtectionPolicy)
- ugsGameSessionId :: Lens' UpdateGameSession Text
- updateGameSessionResponse :: Int -> UpdateGameSessionResponse
- data UpdateGameSessionResponse
- ugsrsGameSession :: Lens' UpdateGameSessionResponse (Maybe GameSession)
- ugsrsResponseStatus :: Lens' UpdateGameSessionResponse Int
Creating a Request
Arguments
| :: Text | |
| -> UpdateGameSession |
Creates a value of UpdateGameSession with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateGameSession Source
Represents the input for a request action.
See: updateGameSession smart constructor.
Instances
Request Lenses
ugsMaximumPlayerSessionCount :: Lens' UpdateGameSession (Maybe Natural) Source
Maximum number of players that can be simultaneously connected to the game session.
ugsPlayerSessionCreationPolicy :: Lens' UpdateGameSession (Maybe PlayerSessionCreationPolicy) Source
Policy determining whether or not the game session accepts new players.
ugsName :: Lens' UpdateGameSession (Maybe Text) Source
Descriptive label associated with this game session. Session names do not need to be unique.
ugsProtectionPolicy :: Lens' UpdateGameSession (Maybe ProtectionPolicy) Source
Game session protection policy to apply to this game session only.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
ugsGameSessionId :: Lens' UpdateGameSession Text Source
Unique identifier for a game session. Specify the game session you want to update.
Destructuring the Response
updateGameSessionResponse Source
Arguments
| :: Int | |
| -> UpdateGameSessionResponse |
Creates a value of UpdateGameSessionResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateGameSessionResponse Source
Represents the returned data in response to a request action.
See: updateGameSessionResponse smart constructor.
Response Lenses
ugsrsGameSession :: Lens' UpdateGameSessionResponse (Maybe GameSession) Source
Object containing the updated game session metadata.
ugsrsResponseStatus :: Lens' UpdateGameSessionResponse Int Source
The response status code.