Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
- updateGameSessionQueue :: Text -> UpdateGameSessionQueue
- data UpdateGameSessionQueue
- ugsqPlayerLatencyPolicies :: Lens' UpdateGameSessionQueue [PlayerLatencyPolicy]
- ugsqTimeoutInSeconds :: Lens' UpdateGameSessionQueue (Maybe Natural)
- ugsqDestinations :: Lens' UpdateGameSessionQueue [GameSessionQueueDestination]
- ugsqName :: Lens' UpdateGameSessionQueue Text
- updateGameSessionQueueResponse :: Int -> UpdateGameSessionQueueResponse
- data UpdateGameSessionQueueResponse
- ugsqrsGameSessionQueue :: Lens' UpdateGameSessionQueueResponse (Maybe GameSessionQueue)
- ugsqrsResponseStatus :: Lens' UpdateGameSessionQueueResponse Int
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 aTIMED_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.
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:
ugsqrsGameSessionQueue
- Object that describes the newly updated game session queue.ugsqrsResponseStatus
- -- | The response status code.
data UpdateGameSessionQueueResponse Source #
Represents the returned data in response to a request action.
See: updateGameSessionQueueResponse
smart constructor.
Response Lenses
ugsqrsGameSessionQueue :: Lens' UpdateGameSessionQueueResponse (Maybe GameSessionQueue) Source #
Object that describes the newly updated game session queue.
ugsqrsResponseStatus :: Lens' UpdateGameSessionQueueResponse Int Source #
- - | The response status code.