libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.UpdateGameSession

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.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Synopsis

Creating a Request

data UpdateGameSession Source #

Represents the input for a request operation.

See: newUpdateGameSession smart constructor.

Constructors

UpdateGameSession' 

Fields

Instances

Instances details
Eq UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Read UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Show UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Generic UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Associated Types

type Rep UpdateGameSession :: Type -> Type #

NFData UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Methods

rnf :: UpdateGameSession -> () #

Hashable UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

ToJSON UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

AWSRequest UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Associated Types

type AWSResponse UpdateGameSession #

ToHeaders UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

ToPath UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

ToQuery UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

type Rep UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

type Rep UpdateGameSession = D1 ('MetaData "UpdateGameSession" "Amazonka.GameLift.UpdateGameSession" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "UpdateGameSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maximumPlayerSessionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "playerSessionCreationPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlayerSessionCreationPolicy))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "protectionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtectionPolicy)) :*: S1 ('MetaSel ('Just "gameSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateGameSession Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

newUpdateGameSession Source #

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:

$sel:maximumPlayerSessionCount:UpdateGameSession', updateGameSession_maximumPlayerSessionCount - The maximum number of players that can be connected simultaneously to the game session.

$sel:playerSessionCreationPolicy:UpdateGameSession', updateGameSession_playerSessionCreationPolicy - A policy that determines whether the game session is accepting new players.

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

$sel:protectionPolicy: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.

$sel:gameSessionId: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_playerSessionCreationPolicy :: Lens' UpdateGameSession (Maybe PlayerSessionCreationPolicy) Source #

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

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_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 #

Represents the returned data in response to a request operation.

See: newUpdateGameSessionResponse smart constructor.

Constructors

UpdateGameSessionResponse' 

Fields

Instances

Instances details
Eq UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Read UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Show UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Generic UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

Associated Types

type Rep UpdateGameSessionResponse :: Type -> Type #

NFData UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

type Rep UpdateGameSessionResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSession

type Rep UpdateGameSessionResponse = D1 ('MetaData "UpdateGameSessionResponse" "Amazonka.GameLift.UpdateGameSession" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" '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 #

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:

$sel:gameSession:UpdateGameSessionResponse', updateGameSessionResponse_gameSession - The updated game session properties.

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

Response Lenses