Network.AWS.GameLift.UpdateGameSessionQueue

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:

• CreateGameSessionQueue
• DescribeGameSessionQueues
• UpdateGameSessionQueue
• DeleteGameSessionQueue

Creating a Request

updateGameSessionQueue

Arguments

:: Text

ugsqName

-> UpdateGameSessionQueue

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

Represents the input for a request action.

See: updateGameSessionQueue smart constructor.

Instances

Eq UpdateGameSessionQueue

Methods

(==) :: UpdateGameSessionQueue -> UpdateGameSessionQueue -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS UpdateGameSessionQueue

readList :: ReadS [UpdateGameSessionQueue]

readPrec :: ReadPrec UpdateGameSessionQueue

readListPrec :: ReadPrec [UpdateGameSessionQueue]

Show UpdateGameSessionQueue

Methods

showsPrec :: Int -> UpdateGameSessionQueue -> ShowS

show :: UpdateGameSessionQueue -> String

showList :: [UpdateGameSessionQueue] -> ShowS

Generic UpdateGameSessionQueue

Associated Types

type Rep UpdateGameSessionQueue :: * -> *

Methods

from :: UpdateGameSessionQueue -> Rep UpdateGameSessionQueue x

to :: Rep UpdateGameSessionQueue x -> UpdateGameSessionQueue

Hashable UpdateGameSessionQueue

Methods

hashWithSalt :: Int -> UpdateGameSessionQueue -> Int

hash :: UpdateGameSessionQueue -> Int

ToJSON UpdateGameSessionQueue

Methods

toJSON :: UpdateGameSessionQueue -> Value

toEncoding :: UpdateGameSessionQueue -> Encoding

toJSONList :: [UpdateGameSessionQueue] -> Value

toEncodingList :: [UpdateGameSessionQueue] -> Encoding

NFData UpdateGameSessionQueue

Methods

rnf :: UpdateGameSessionQueue -> ()

AWSRequest UpdateGameSessionQueue

Associated Types

type Rs UpdateGameSessionQueue :: *

Methods

request :: UpdateGameSessionQueue -> Request UpdateGameSessionQueue

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

ToQuery UpdateGameSessionQueue

Methods

toQuery :: UpdateGameSessionQueue -> QueryString

ToPath UpdateGameSessionQueue

Methods

toPath :: UpdateGameSessionQueue -> ByteString

ToHeaders UpdateGameSessionQueue

Methods

toHeaders :: UpdateGameSessionQueue -> [Header]

type Rep UpdateGameSessionQueue

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

type Rs UpdateGameSessionQueue

type Rs UpdateGameSessionQueue = UpdateGameSessionQueueResponse

Request Lenses

ugsqPlayerLatencyPolicies :: Lens' UpdateGameSessionQueue [PlayerLatencyPolicy]

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)

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]

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

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

Destructuring the Response

updateGameSessionQueueResponse

Arguments

:: Int

ugsqrsResponseStatus

-> UpdateGameSessionQueueResponse

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:

• ugsqrsGameSessionQueue - Object that describes the newly updated game session queue.
• ugsqrsResponseStatus - -- | The response status code.

data UpdateGameSessionQueueResponse

Represents the returned data in response to a request action.

See: updateGameSessionQueueResponse smart constructor.

Instances

Eq UpdateGameSessionQueueResponse

Methods

(==) :: UpdateGameSessionQueueResponse -> UpdateGameSessionQueueResponse -> Bool

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

Data UpdateGameSessionQueueResponse

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

Methods

readsPrec :: Int -> ReadS UpdateGameSessionQueueResponse

readList :: ReadS [UpdateGameSessionQueueResponse]

readPrec :: ReadPrec UpdateGameSessionQueueResponse

readListPrec :: ReadPrec [UpdateGameSessionQueueResponse]

Show UpdateGameSessionQueueResponse

Methods

showsPrec :: Int -> UpdateGameSessionQueueResponse -> ShowS

show :: UpdateGameSessionQueueResponse -> String

showList :: [UpdateGameSessionQueueResponse] -> ShowS

Generic UpdateGameSessionQueueResponse

Associated Types

type Rep UpdateGameSessionQueueResponse :: * -> *

Methods

from :: UpdateGameSessionQueueResponse -> Rep UpdateGameSessionQueueResponse x

to :: Rep UpdateGameSessionQueueResponse x -> UpdateGameSessionQueueResponse

NFData UpdateGameSessionQueueResponse

Methods

rnf :: UpdateGameSessionQueueResponse -> ()

type Rep UpdateGameSessionQueueResponse

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

Response Lenses

ugsqrsGameSessionQueue :: Lens' UpdateGameSessionQueueResponse (Maybe GameSessionQueue)

Object that describes the newly updated game session queue.

ugsqrsResponseStatus :: Lens' UpdateGameSessionQueueResponse Int

• - | The response status code.