Skip to content

PriorityConfiguration

Source code in docs_src/capo_gamelift/types/priority_configuration.py
class PriorityConfiguration(TypedDict, closed=True):
    priority_order: NotRequired[
        "capo_gamelift.types.priority_type_list.PriorityTypeList"
    ]
    """<p>A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.</p> <ul> <li> <p> <code>LATENCY</code> -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.</p> </li> <li> <p> <code>COST</code> -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).</p> </li> <li> <p> <code>DESTINATION</code> -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.</p> </li> <li> <p> <code>LOCATION</code> -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in <code>LocationOrder</code>. </p> </li> </ul>"""
    location_order: NotRequired["capo_gamelift.types.location_list.LocationList"]
    """<p>The prioritization order to use for fleet locations, when the <code>PriorityOrder</code> property includes <code>LOCATION</code>. Locations can include Amazon Web Services Region codes (such as <code>us-west-2</code>), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html">Amazon GameLift Servers service locations.</a> </p>"""

location_order instance-attribute

location_order: NotRequired[LocationList]

The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services Region codes (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.

priority_order instance-attribute

priority_order: NotRequired[PriorityTypeList]

A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.

  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).

  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.

  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder.