Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.GameLift.UpdateGameSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Game-session-related operations include:

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
StartGameSessionPlacement
DescribeGameSessionPlacement
StopGameSessionPlacement

Creating a Request

updateGameSession #

Arguments

:: Text	`ugsGameSessionId`
-> 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:

ugsMaximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.
ugsPlayerSessionCreationPolicy - Policy determining whether or not the game session accepts new players.
ugsName - Descriptive label that is associated with a game session. Session names do not need to be unique.
ugsProtectionPolicy - 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 - Unique identifier for the game session to update.

data UpdateGameSession #

Represents the input for a request action.

See: updateGameSession smart constructor.

Instances

Eq UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods (==) :: UpdateGameSession -> UpdateGameSession -> Bool # (/=) :: UpdateGameSession -> UpdateGameSession -> Bool #
Data UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGameSession -> c UpdateGameSession # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGameSession # toConstr :: UpdateGameSession -> Constr # dataTypeOf :: UpdateGameSession -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGameSession) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGameSession) # gmapT :: (forall b. Data b => b -> b) -> UpdateGameSession -> UpdateGameSession # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSession -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSession -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateGameSession -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGameSession -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGameSession -> m UpdateGameSession # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSession -> m UpdateGameSession # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSession -> m UpdateGameSession #
Read UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods readsPrec :: Int -> ReadS UpdateGameSession # readList :: ReadS [UpdateGameSession] # readPrec :: ReadPrec UpdateGameSession # readListPrec :: ReadPrec [UpdateGameSession] #
Show UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods showsPrec :: Int -> UpdateGameSession -> ShowS # show :: UpdateGameSession -> String # showList :: [UpdateGameSession] -> ShowS #
Generic UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Associated Types type Rep UpdateGameSession :: * -> * # Methods from :: UpdateGameSession -> Rep UpdateGameSession x # to :: Rep UpdateGameSession x -> UpdateGameSession #
Hashable UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods hashWithSalt :: Int -> UpdateGameSession -> Int # hash :: UpdateGameSession -> Int #
ToJSON UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods toJSON :: UpdateGameSession -> Value # toEncoding :: UpdateGameSession -> Encoding # toJSONList :: [UpdateGameSession] -> Value # toEncodingList :: [UpdateGameSession] -> Encoding #
AWSRequest UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Associated Types type Rs UpdateGameSession :: * # Methods request :: UpdateGameSession -> Request UpdateGameSession # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateGameSession -> ClientResponse -> m (Response UpdateGameSession) #
ToHeaders UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods toHeaders :: UpdateGameSession -> [Header] #
ToPath UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods toPath :: UpdateGameSession -> ByteString #
ToQuery UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods toQuery :: UpdateGameSession -> QueryString #
NFData UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods rnf :: UpdateGameSession -> () #
type Rep UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession type Rep UpdateGameSession = D1 (MetaData "UpdateGameSession" "Network.AWS.GameLift.UpdateGameSession" "amazonka-gamelift-1.6.0-7WgXOZKdxV3Gu4LRJZfX7W" False) (C1 (MetaCons "UpdateGameSession'" PrefixI True) ((S1 (MetaSel (Just "_ugsMaximumPlayerSessionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: S1 (MetaSel (Just "_ugsPlayerSessionCreationPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PlayerSessionCreationPolicy))) :: (S1 (MetaSel (Just "_ugsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_ugsProtectionPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProtectionPolicy)) :: S1 (MetaSel (Just "_ugsGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs UpdateGameSession #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession type Rs UpdateGameSession = UpdateGameSessionResponse

Request Lenses

ugsMaximumPlayerSessionCount :: Lens' UpdateGameSession (Maybe Natural) #

Maximum number of players that can be connected simultaneously to the game session.

ugsPlayerSessionCreationPolicy :: Lens' UpdateGameSession (Maybe PlayerSessionCreationPolicy) #

Policy determining whether or not the game session accepts new players.

ugsName :: Lens' UpdateGameSession (Maybe Text) #

Descriptive label that is associated with a game session. Session names do not need to be unique.

ugsProtectionPolicy :: Lens' UpdateGameSession (Maybe ProtectionPolicy) #

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 #

Unique identifier for the game session to update.

Destructuring the Response

updateGameSessionResponse #

Arguments

:: Int	`ugsrsResponseStatus`
-> 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:

ugsrsGameSession - Object that contains the updated game session metadata.
ugsrsResponseStatus - -- | The response status code.

data UpdateGameSessionResponse #

Represents the returned data in response to a request action.

See: updateGameSessionResponse smart constructor.

Instances

Eq UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods (==) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool # (/=) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool #
Data UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGameSessionResponse -> c UpdateGameSessionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGameSessionResponse # toConstr :: UpdateGameSessionResponse -> Constr # dataTypeOf :: UpdateGameSessionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGameSessionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGameSessionResponse) # gmapT :: (forall b. Data b => b -> b) -> UpdateGameSessionResponse -> UpdateGameSessionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateGameSessionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGameSessionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGameSessionResponse -> m UpdateGameSessionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionResponse -> m UpdateGameSessionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionResponse -> m UpdateGameSessionResponse #
Read UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods readsPrec :: Int -> ReadS UpdateGameSessionResponse # readList :: ReadS [UpdateGameSessionResponse] # readPrec :: ReadPrec UpdateGameSessionResponse # readListPrec :: ReadPrec [UpdateGameSessionResponse] #
Show UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods showsPrec :: Int -> UpdateGameSessionResponse -> ShowS # show :: UpdateGameSessionResponse -> String # showList :: [UpdateGameSessionResponse] -> ShowS #
Generic UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Associated Types type Rep UpdateGameSessionResponse :: * -> * # Methods from :: UpdateGameSessionResponse -> Rep UpdateGameSessionResponse x # to :: Rep UpdateGameSessionResponse x -> UpdateGameSessionResponse #
NFData UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession Methods rnf :: UpdateGameSessionResponse -> () #
type Rep UpdateGameSessionResponse #
Instance details Defined in Network.AWS.GameLift.UpdateGameSession type Rep UpdateGameSessionResponse = D1 (MetaData "UpdateGameSessionResponse" "Network.AWS.GameLift.UpdateGameSession" "amazonka-gamelift-1.6.0-7WgXOZKdxV3Gu4LRJZfX7W" False) (C1 (MetaCons "UpdateGameSessionResponse'" PrefixI True) (S1 (MetaSel (Just "_ugsrsGameSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GameSession)) :*: S1 (MetaSel (Just "_ugsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ugsrsGameSession :: Lens' UpdateGameSessionResponse (Maybe GameSession) #

Object that contains the updated game session metadata.

ugsrsResponseStatus :: Lens' UpdateGameSessionResponse Int #

- | The response status code.