Network.AWS.GameLift.UpdateGameSession

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.

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 simultaneously connected to the game session.
• ugsPlayerSessionCreationPolicy - Policy determining whether or not the game session accepts new players.
• ugsName - Descriptive label 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. Game session ID format is as follows: "arn:aws:gamelift:region::gamesessionfleet-IDstring". The value of string is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

data UpdateGameSession

Represents the input for a request action.

See: updateGameSession smart constructor.

Instances

Eq UpdateGameSession

Methods

(==) :: UpdateGameSession -> UpdateGameSession -> Bool

(/=) :: UpdateGameSession -> UpdateGameSession -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS UpdateGameSession

readList :: ReadS [UpdateGameSession]

readPrec :: ReadPrec UpdateGameSession

readListPrec :: ReadPrec [UpdateGameSession]

Show UpdateGameSession

Methods

showsPrec :: Int -> UpdateGameSession -> ShowS

show :: UpdateGameSession -> String

showList :: [UpdateGameSession] -> ShowS

Generic UpdateGameSession

Associated Types

type Rep UpdateGameSession :: * -> *

Methods

from :: UpdateGameSession -> Rep UpdateGameSession x

to :: Rep UpdateGameSession x -> UpdateGameSession

Hashable UpdateGameSession

Methods

hashWithSalt :: Int -> UpdateGameSession -> Int

hash :: UpdateGameSession -> Int

ToJSON UpdateGameSession

Methods

toJSON :: UpdateGameSession -> Value

toEncoding :: UpdateGameSession -> Encoding

toJSONList :: [UpdateGameSession] -> Value

toEncodingList :: [UpdateGameSession] -> Encoding

NFData UpdateGameSession

Methods

rnf :: UpdateGameSession -> ()

AWSRequest UpdateGameSession

Associated Types

type Rs UpdateGameSession :: *

Methods

request :: UpdateGameSession -> Request UpdateGameSession

response :: MonadResource m => Logger -> Service -> Proxy * UpdateGameSession -> ClientResponse -> m (Response UpdateGameSession)

ToPath UpdateGameSession

Methods

toPath :: UpdateGameSession -> ByteString

ToHeaders UpdateGameSession

Methods

toHeaders :: UpdateGameSession -> [Header]

ToQuery UpdateGameSession

Methods

toQuery :: UpdateGameSession -> QueryString

type Rep UpdateGameSession

type Rep UpdateGameSession = D1 (MetaData "UpdateGameSession" "Network.AWS.GameLift.UpdateGameSession" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "UpdateGameSession'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ugsMaximumPlayerSessionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ugsPlayerSessionCreationPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PlayerSessionCreationPolicy)))) ((:*:) (S1 (MetaSel (Just Symbol "_ugsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ugsProtectionPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProtectionPolicy))) (S1 (MetaSel (Just Symbol "_ugsGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs UpdateGameSession

type Rs UpdateGameSession = UpdateGameSessionResponse

Request Lenses

ugsMaximumPlayerSessionCount :: Lens' UpdateGameSession (Maybe Natural)

Maximum number of players that can be simultaneously connected 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 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. Game session ID format is as follows: "arn:aws:gamelift:region::gamesessionfleet-IDstring". The value of string is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

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 containing 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

Methods

(==) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool

(/=) :: UpdateGameSessionResponse -> UpdateGameSessionResponse -> Bool

Data UpdateGameSessionResponse

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

Methods

readsPrec :: Int -> ReadS UpdateGameSessionResponse

readList :: ReadS [UpdateGameSessionResponse]

readPrec :: ReadPrec UpdateGameSessionResponse

readListPrec :: ReadPrec [UpdateGameSessionResponse]

Show UpdateGameSessionResponse

Methods

showsPrec :: Int -> UpdateGameSessionResponse -> ShowS

show :: UpdateGameSessionResponse -> String

showList :: [UpdateGameSessionResponse] -> ShowS

Generic UpdateGameSessionResponse

Associated Types

type Rep UpdateGameSessionResponse :: * -> *

Methods

from :: UpdateGameSessionResponse -> Rep UpdateGameSessionResponse x

to :: Rep UpdateGameSessionResponse x -> UpdateGameSessionResponse

NFData UpdateGameSessionResponse

Methods

rnf :: UpdateGameSessionResponse -> ()

type Rep UpdateGameSessionResponse

type Rep UpdateGameSessionResponse = D1 (MetaData "UpdateGameSessionResponse" "Network.AWS.GameLift.UpdateGameSession" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "UpdateGameSessionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ugsrsGameSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GameSession))) (S1 (MetaSel (Just Symbol "_ugsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

ugsrsGameSession :: Lens' UpdateGameSessionResponse (Maybe GameSession)

Object containing the updated game session metadata.

ugsrsResponseStatus :: Lens' UpdateGameSessionResponse Int

• - | The response status code.