GameLift / Client / create_game_session_queue

create_game_session_queue#

GameLift.Client.create_game_session_queue(**kwargs)#

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet’s remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue’s destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue’s name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.create_game_session_queue(
    Name='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',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

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

  • 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 to be 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.

  • Tags (list) –

    A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    • (dict) –

      A label that you can assign to a Amazon GameLift resource.

      Learn more

      Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

      Amazon Web Services Tagging Strategies

      Related actions

      All APIs by task

      • Key (string) – [REQUIRED]

        The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

      • Value (string) – [REQUIRED]

        The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

Return type:

dict

Returns:

Response Syntax

{
    'GameSessionQueue': {
        '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'
    }
}

Response Structure

  • (dict) –

    • GameSessionQueue (dict) –

      An object that describes the newly created game session queue.

      • 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.

Exceptions