Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.UpdateGameSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

All APIs by task

Synopsis

Creating a Request

data UpdateGameSession Source #

See: newUpdateGameSession smart constructor.

Constructors

UpdateGameSession'

Fields

maximumPlayerSessionCount :: Maybe Natural
The maximum number of players that can be connected simultaneously to the game session.
name :: Maybe Text
A descriptive label that is associated with a game session. Session names do not need to be unique.
playerSessionCreationPolicy :: Maybe PlayerSessionCreationPolicy
A policy that determines whether the game session is accepting new players.
protectionPolicy :: 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.
gameSessionId :: Text
A unique identifier for the game session to update.

Instances

Instances details

ToJSON UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods toJSON :: UpdateGameSession -> Value # toEncoding :: UpdateGameSession -> Encoding # toJSONList :: [UpdateGameSession] -> Value # toEncodingList :: [UpdateGameSession] -> Encoding #
ToHeaders UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods toHeaders :: UpdateGameSession -> [Header] #
ToPath UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods toPath :: UpdateGameSession -> ByteString #
ToQuery UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods toQuery :: UpdateGameSession -> QueryString #
AWSRequest UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Associated Types type AWSResponse UpdateGameSession # Methods request :: (Service -> Service) -> UpdateGameSession -> Request UpdateGameSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGameSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGameSession))) #
Generic UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Associated Types type Rep UpdateGameSession :: Type -> Type # Methods from :: UpdateGameSession -> Rep UpdateGameSession x # to :: Rep UpdateGameSession x -> UpdateGameSession #
Read UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods readsPrec :: Int -> ReadS UpdateGameSession # readList :: ReadS [UpdateGameSession] # readPrec :: ReadPrec UpdateGameSession # readListPrec :: ReadPrec [UpdateGameSession] #
Show UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods showsPrec :: Int -> UpdateGameSession -> ShowS # show :: UpdateGameSession -> String # showList :: [UpdateGameSession] -> ShowS #
NFData UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods rnf :: UpdateGameSession -> () #
Eq UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods (==) :: UpdateGameSession -> UpdateGameSession -> Bool # (/=) :: UpdateGameSession -> UpdateGameSession -> Bool #
Hashable UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods hashWithSalt :: Int -> UpdateGameSession -> Int # hash :: UpdateGameSession -> Int #
type AWSResponse UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession type AWSResponse UpdateGameSession = UpdateGameSessionResponse
type Rep UpdateGameSession Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession type Rep UpdateGameSession = D1 ('MetaData "UpdateGameSession" "Amazonka.GameLift.UpdateGameSession" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maximumPlayerSessionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "playerSessionCreationPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlayerSessionCreationPolicy)) :: (S1 ('MetaSel ('Just "protectionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtectionPolicy)) :: S1 ('MetaSel ('Just "gameSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGameSession Source #

Arguments

:: Text	`UpdateGameSession`
-> UpdateGameSession

Create a value of UpdateGameSession with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateGameSession, updateGameSession_maximumPlayerSessionCount - The maximum number of players that can be connected simultaneously to the game session.

UpdateGameSession, updateGameSession_name - A descriptive label that is associated with a game session. Session names do not need to be unique.

UpdateGameSession, updateGameSession_playerSessionCreationPolicy - A policy that determines whether the game session is accepting new players.

UpdateGameSession, updateGameSession_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.

UpdateGameSession, updateGameSession_gameSessionId - A unique identifier for the game session to update.

Request Lenses

updateGameSession_maximumPlayerSessionCount :: Lens' UpdateGameSession (Maybe Natural) Source #

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

updateGameSession_name :: Lens' UpdateGameSession (Maybe Text) Source #

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

updateGameSession_playerSessionCreationPolicy :: Lens' UpdateGameSession (Maybe PlayerSessionCreationPolicy) Source #

A policy that determines whether the game session is accepting new players.

updateGameSession_protectionPolicy :: 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.

updateGameSession_gameSessionId :: Lens' UpdateGameSession Text Source #

A unique identifier for the game session to update.

Destructuring the Response

data UpdateGameSessionResponse Source #

See: newUpdateGameSessionResponse smart constructor.

Constructors

UpdateGameSessionResponse'
Fields gameSession :: Maybe GameSession The updated game session properties. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Associated Types type Rep UpdateGameSessionResponse :: Type -> Type # Methods from :: UpdateGameSessionResponse -> Rep UpdateGameSessionResponse x # to :: Rep UpdateGameSessionResponse x -> UpdateGameSessionResponse #
Read UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods readsPrec :: Int -> ReadS UpdateGameSessionResponse # readList :: ReadS [UpdateGameSessionResponse] # readPrec :: ReadPrec UpdateGameSessionResponse # readListPrec :: ReadPrec [UpdateGameSessionResponse] #
Show UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods showsPrec :: Int -> UpdateGameSessionResponse -> ShowS # show :: UpdateGameSessionResponse -> String # showList :: [UpdateGameSessionResponse] -> ShowS #
NFData UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods rnf :: UpdateGameSessionResponse -> () #
Eq UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession Methods (==) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool # (/=) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool #
type Rep UpdateGameSessionResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameSession type Rep UpdateGameSessionResponse = D1 ('MetaData "UpdateGameSessionResponse" "Amazonka.GameLift.UpdateGameSession" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameSession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateGameSessionResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateGameSessionResponse'`
-> UpdateGameSessionResponse

Create a value of UpdateGameSessionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateGameSessionResponse, updateGameSessionResponse_gameSession - The updated game session properties.

$sel:httpStatus:UpdateGameSessionResponse', updateGameSessionResponse_httpStatus - The response's http status code.

Response Lenses

updateGameSessionResponse_gameSession :: Lens' UpdateGameSessionResponse (Maybe GameSession) Source #

The updated game session properties.

updateGameSessionResponse_httpStatus :: Lens' UpdateGameSessionResponse Int Source #

The response's http status code.