class Aws::GameLift::Types::UpdateGameSessionQueueInput
Represents the input for a request operation.
@note When making an API call, you may pass UpdateGameSessionQueueInput
data as a hash: { name: "GameSessionQueueNameOrArn", # required timeout_in_seconds: 1, player_latency_policies: [ { maximum_individual_player_latency_milliseconds: 1, policy_duration_seconds: 1, }, ], destinations: [ { destination_arn: "ArnStringModel", }, ], filter_configuration: { allowed_locations: ["LocationStringModel"], }, priority_configuration: { priority_order: ["LATENCY"], # accepts LATENCY, COST, DESTINATION, LOCATION location_order: ["LocationStringModel"], }, custom_event_data: "QueueCustomEventData", notification_target: "QueueSnsArnStringModel", }
@!attribute [rw] name
A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. @return [String]
@!attribute [rw] timeout_in_seconds
The 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. @return [Integer]
@!attribute [rw] player_latency_policies
A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies. @return [Array<Types::PlayerLatencyPolicy>]
@!attribute [rw] destinations
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations. @return [Array<Types::GameSessionQueueDestination>]
@!attribute [rw] filter_configuration
A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as `us-west-2`. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set. @return [Types::FilterConfiguration]
@!attribute [rw] priority_configuration
Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set. @return [Types::PriorityConfiguration]
@!attribute [rw] custom_event_data
Information to be added to all events that are related to this game session queue. @return [String]
@!attribute [rw] notification_target
An SNS topic ARN that is set up to receive game session placement notifications. See [ Setting up notifications for game session placement][1]. [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSessionQueueInput AWS API Documentation
Constants
- SENSITIVE