Skip to content

/AWS1/CL_GML=>UPDATEGAMESESSIONQUEUE()

About UpdateGameSessionQueue

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

Learn more

Using Multi-Region Queues

Method Signature

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/GMLGAMESESSQUEUENAMEOR00 /AWS1/GMLGAMESESSQUEUENAMEOR00

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.

Optional arguments:

IV_TIMEOUTINSECONDS TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER

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. By default, this property is set to 600.

IT_PLAYERLATENCYPOLICIES TYPE /AWS1/CL_GMLPLAYERLATENCYPLY=>TT_PLAYERLATENCYPOLICYLIST TT_PLAYERLATENCYPOLICYLIST

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.

IT_DESTINATIONS TYPE /AWS1/CL_GMLGAMESESSQUEUEDST=>TT_GAMESESSIONQUEUEDSTLIST TT_GAMESESSIONQUEUEDSTLIST

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.

IO_FILTERCONFIGURATION TYPE REF TO /AWS1/CL_GMLFILTERCONF /AWS1/CL_GMLFILTERCONF

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services 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.

IO_PRIORITYCONFIGURATION TYPE REF TO /AWS1/CL_GMLPRIORITYCONF /AWS1/CL_GMLPRIORITYCONF

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.

IV_CUSTOMEVENTDATA TYPE /AWS1/GMLQUEUECUSTOMEVENTDATA /AWS1/GMLQUEUECUSTOMEVENTDATA

Information to be added to all events that are related to this game session queue.

IV_NOTIFICATIONTARGET TYPE /AWS1/GMLQUEUESNSARNSTRMODEL /AWS1/GMLQUEUESNSARNSTRMODEL

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLUPGAMESESSQUEUEOUT /AWS1/CL_GMLUPGAMESESSQUEUEOUT