GameLift / Client / describe_game_session_queues

describe_game_session_queues#

GameLift.Client.describe_game_session_queues(**kwargs)#

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

See also: AWS API Documentation

Request Syntax

response = client.describe_game_session_queues(
    Names=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
Parameters:

  • Names (list) –

    A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

    • (string) –

  • Limit (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

  • NextToken (string) – A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type:

dict

Returns:

Response Syntax

{
    'GameSessionQueues': [
        {
            'Name': 'string',
            'GameSessionQueueArn': 'string',
            'TimeoutInSeconds': 123,
            'PlayerLatencyPolicies': [
                {
                    'MaximumIndividualPlayerLatencyMilliseconds': 123,
                    'PolicyDurationSeconds': 123
                },
            ],
            'Destinations': [
                {
                    'DestinationArn': 'string'
                },
            ],
            'FilterConfiguration': {
                'AllowedLocations': [
                    'string',
                ]
            },
            'PriorityConfiguration': {
                'PriorityOrder': [
                    'LATENCY'|'COST'|'DESTINATION'|'LOCATION',
                ],
                'LocationOrder': [
                    'string',
                ]
            },
            'CustomEventData': 'string',
            'NotificationTarget': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • GameSessionQueues (list) –

      A collection of objects that describe the requested game session queues.

      • (dict) –

        Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.

        • Name (string) –

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • GameSessionQueueArn (string) –

          The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

        • TimeoutInSeconds (integer) –

          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.

        • PlayerLatencyPolicies (list) –

          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 can’t make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

          • (dict) –

            Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.

            • MaximumIndividualPlayerLatencyMilliseconds (integer) –

              The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

            • PolicyDurationSeconds (integer) –

              The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

        • Destinations (list) –

          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.

          • (dict) –

            A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue’s destinations.

            • DestinationArn (string) –

              The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

        • FilterConfiguration (dict) –

          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.

          • AllowedLocations (list) –

            A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as us-west-2.

            • (string) –

        • PriorityConfiguration (dict) –

          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.

          • PriorityOrder (list) –

            The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

            • LATENCY – FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

            • COST – FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

            • DESTINATION – FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

            • LOCATION – FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

            • (string) –

          • LocationOrder (list) –

            The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by Amazon Web Services Region codes such as us-west-2. Each location can only be listed once.

            • (string) –

        • CustomEventData (string) –

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

        • NotificationTarget (string) –

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

    • NextToken (string) –

      A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Exceptions

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.UnauthorizedException