amazonka-gamelift-1.6.1: Amazon GameLift SDK.

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

Network.AWS.GameLift.UpdateGameSessionQueue

Contents

Description

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Queue-related operations include:

Synopsis

Creating a Request

updateGameSessionQueue Source #

Creates a value of UpdateGameSessionQueue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ugsqPlayerLatencyPolicies - Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.
  • ugsqTimeoutInSeconds - Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
  • ugsqDestinations - List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.
  • ugsqName - Descriptive label that is associated with game session queue. Queue names must be unique within each region.

data UpdateGameSessionQueue Source #

Represents the input for a request action.

See: updateGameSessionQueue smart constructor.

Instances
Eq UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Data UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGameSessionQueue -> c UpdateGameSessionQueue #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGameSessionQueue #

toConstr :: UpdateGameSessionQueue -> Constr #

dataTypeOf :: UpdateGameSessionQueue -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGameSessionQueue) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGameSessionQueue) #

gmapT :: (forall b. Data b => b -> b) -> UpdateGameSessionQueue -> UpdateGameSessionQueue #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionQueue -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionQueue -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateGameSessionQueue -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGameSessionQueue -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueue -> m UpdateGameSessionQueue #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueue -> m UpdateGameSessionQueue #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueue -> m UpdateGameSessionQueue #

Read UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Show UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Generic UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Associated Types

type Rep UpdateGameSessionQueue :: Type -> Type #

Hashable UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

ToJSON UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

AWSRequest UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Associated Types

type Rs UpdateGameSessionQueue :: Type #

ToHeaders UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

ToPath UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

ToQuery UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

NFData UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Methods

rnf :: UpdateGameSessionQueue -> () #

type Rep UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueue = D1 (MetaData "UpdateGameSessionQueue" "Network.AWS.GameLift.UpdateGameSessionQueue" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "UpdateGameSessionQueue'" PrefixI True) ((S1 (MetaSel (Just "_ugsqPlayerLatencyPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlayerLatencyPolicy])) :*: S1 (MetaSel (Just "_ugsqTimeoutInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_ugsqDestinations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameSessionQueueDestination])) :*: S1 (MetaSel (Just "_ugsqName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs UpdateGameSessionQueue Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Request Lenses

ugsqPlayerLatencyPolicies :: Lens' UpdateGameSessionQueue [PlayerLatencyPolicy] Source #

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

ugsqTimeoutInSeconds :: Lens' UpdateGameSessionQueue (Maybe Natural) Source #

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

ugsqDestinations :: Lens' UpdateGameSessionQueue [GameSessionQueueDestination] Source #

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

ugsqName :: Lens' UpdateGameSessionQueue Text Source #

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Destructuring the Response

updateGameSessionQueueResponse Source #

Creates a value of UpdateGameSessionQueueResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UpdateGameSessionQueueResponse Source #

Represents the returned data in response to a request action.

See: updateGameSessionQueueResponse smart constructor.

Instances
Eq UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Data UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGameSessionQueueResponse -> c UpdateGameSessionQueueResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGameSessionQueueResponse #

toConstr :: UpdateGameSessionQueueResponse -> Constr #

dataTypeOf :: UpdateGameSessionQueueResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGameSessionQueueResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGameSessionQueueResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateGameSessionQueueResponse -> UpdateGameSessionQueueResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionQueueResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGameSessionQueueResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateGameSessionQueueResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGameSessionQueueResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueueResponse -> m UpdateGameSessionQueueResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueueResponse -> m UpdateGameSessionQueueResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGameSessionQueueResponse -> m UpdateGameSessionQueueResponse #

Read UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Show UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Generic UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

Associated Types

type Rep UpdateGameSessionQueueResponse :: Type -> Type #

NFData UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueueResponse = D1 (MetaData "UpdateGameSessionQueueResponse" "Network.AWS.GameLift.UpdateGameSessionQueue" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "UpdateGameSessionQueueResponse'" PrefixI True) (S1 (MetaSel (Just "_ugsqrsGameSessionQueue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GameSessionQueue)) :*: S1 (MetaSel (Just "_ugsqrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ugsqrsGameSessionQueue :: Lens' UpdateGameSessionQueueResponse (Maybe GameSessionQueue) Source #

Object that describes the newly updated game session queue.