Skip to content

UpdateGameSessionQueueInput

Source code in docs_src/capo_gamelift/types/update_game_session_queue_input.py
class UpdateGameSessionQueueInput(TypedDict, closed=True):
    name: NotRequired[
        "capo_gamelift.types.game_session_queue_name_or_arn.GameSessionQueueNameOrArn"
    ]
    """<p>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. </p>"""
    timeout_in_seconds: NotRequired["capo_gamelift.types.whole_number.WholeNumber"]
    """<p>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 <code>TIMED_OUT</code> status.</p> <note> <p>The minimum value is 10 and the maximum value is 600.</p> </note>"""
    player_latency_policies: NotRequired[
        "capo_gamelift.types.player_latency_policy_list.PlayerLatencyPolicyList"
    ]
    """<p>A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value. When updating policies, provide a complete collection of policies.</p>"""
    destinations: NotRequired[
        "capo_gamelift.types.game_session_queue_destination_list.GameSessionQueueDestinationList"
    ]
    """<p>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.</p>"""
    filter_configuration: NotRequired[
        "capo_gamelift.types.filter_configuration.FilterConfiguration"
    ]
    """<p>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 <code>us-west-2</code>. 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.</p>"""
    priority_configuration: NotRequired[
        "capo_gamelift.types.priority_configuration.PriorityConfiguration"
    ]
    """<p>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.</p>"""
    custom_event_data: NotRequired[
        "capo_gamelift.types.queue_custom_event_data.QueueCustomEventData"
    ]
    """<p>Information to be added to all events that are related to this game session queue.</p>"""
    notification_target: NotRequired[
        "capo_gamelift.types.queue_sns_arn_string_model.QueueSnsArnStringModel"
    ]
    """<p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>"""

custom_event_data instance-attribute

custom_event_data: NotRequired[QueueCustomEventData]

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

destinations instance-attribute

destinations: NotRequired[GameSessionQueueDestinationList]

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.

filter_configuration instance-attribute

filter_configuration: NotRequired[FilterConfiguration]

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.

name instance-attribute

name: NotRequired[GameSessionQueueNameOrArn]

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.

notification_target instance-attribute

notification_target: NotRequired[QueueSnsArnStringModel]

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

player_latency_policies instance-attribute

player_latency_policies: NotRequired[PlayerLatencyPolicyList]

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value. When updating policies, provide a complete collection of policies.

priority_configuration instance-attribute

priority_configuration: NotRequired[PriorityConfiguration]

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.

timeout_in_seconds instance-attribute

timeout_in_seconds: NotRequired[WholeNumber]

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.

The minimum value is 10 and the maximum value is 600.