You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(client-gamelift): Amazon GameLift releases a new game session placement feature: PriorityConfigurationOverride. You can now override how a game session queue prioritizes placement locations for a single StartGameSessionPlacement request.
* <p>Places a request for a new game session in a queue. When processing a placement
37
-
* request, Amazon GameLift searches for available resources on the queue's destinations, scanning
38
-
* each until it finds resources or the placement request times out.</p>
39
-
* <p>A game session placement request can also request player sessions. When a new game
40
-
* session is successfully created, Amazon GameLift creates a player session for each player
41
-
* included in the request.</p>
42
-
* <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are
43
-
* listed in the queue configuration. Ideally, a queue's destinations are listed in
44
-
* preference order.</p>
45
-
* <p>Alternatively, when requesting a game session with players, you can also provide
46
-
* latency data for each player in relevant Regions. Latency data indicates the performance
47
-
* lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency
48
-
* data to reorder the list of destinations to place the game session in a Region with
49
-
* minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each
50
-
* Region's average lag for all players and reorders to get the best game play across all
51
-
* players. </p>
52
-
* <p>To place a new game session request, specify the following:</p>
36
+
* <p>Makes a request to start a new game session using a game session queue. When
37
+
* processing a placement request in a queue, Amazon GameLift finds the best possible available
38
+
* resource to host the game session and prompts the resource to start the game session. </p>
39
+
* <p>
40
+
* <b>Request options</b>
41
+
* </p>
42
+
* <p>Call this API with the following minimum parameters:
43
+
* <i>GameSessionQueueName</i>,
44
+
* <i>MaximumPlayerSessionCount</i>, and
45
+
* <i>PlacementID</i>. You can also include game session data (data formatted
46
+
* as strings) or game properties (data formatted as key-value pairs) to pass to the new
47
+
* game session.</p>
53
48
* <ul>
54
49
* <li>
55
-
* <p>The queue name and a set of game session properties and settings</p>
50
+
* <p>You can change how Amazon GameLift chooses a hosting resource for the new game session.
51
+
* Prioritizing resources for game session placements is defined when you configure
52
+
* a game session queue. You can use the default prioritization process or specify
53
+
* a custom process by providing a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_PriorityConfiguration.html">
54
+
* PriorityConfiguration</a> when you create or update a queue.</p>
55
+
* <ul>
56
+
* <li>
57
+
* <p>Prioritize based on resource cost and location, using the queue's
58
+
* configured priority settings. Call this API with the minimum
59
+
* parameters.</p>
60
+
* </li>
61
+
* <li>
62
+
* <p>Prioritize based on latency. Include a set of values for
63
+
* <i>PlayerLatencies</i>. You can provide latency data
64
+
* with or without player session data. This option instructs Amazon GameLift to
65
+
* reorder the queue's prioritized locations list based on the latency
66
+
* data. If latency data is provided for multiple players, Amazon GameLift
67
+
* calculates each location's average latency for all players and reorders
68
+
* to find the lowest latency across all players. Don't include latency
69
+
* data if you're providing a custom list of locations.</p>
70
+
* </li>
71
+
* <li>
72
+
* <p>Prioritize based on a custom list of locations. If you're using a
73
+
* queue that's configured to prioritize location first (see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_PriorityConfiguration.html">PriorityConfiguration</a> for game session queues), use the
74
+
* <i>PriorityConfigurationOverride</i> parameter to
75
+
* substitute a different location list for this placement request. When
76
+
* prioritizing placements by location, Amazon GameLift searches each location in
77
+
* prioritized order to find an available hosting resource for the new game
78
+
* session. You can choose whether to use the override list for the first
79
+
* placement attempt only or for all attempts.</p>
80
+
* </li>
81
+
* </ul>
56
82
* </li>
57
83
* <li>
58
-
* <p>A unique ID (such as a UUID) for the placement. You use this ID to track the
59
-
* status of the placement request</p>
84
+
* <p>You can request new player sessions for a group of players. Include the
85
+
* <i>DesiredPlayerSessions</i> parameter and include at minimum
86
+
* a unique player ID for each. You can also include player-specific data to pass
87
+
* to the new game session. </p>
60
88
* </li>
89
+
* </ul>
90
+
* <p>
91
+
* <b>Result</b>
92
+
* </p>
93
+
* <p>If successful, this request generates a new game session placement request and adds it
94
+
* to the game session queue for Amazon GameLift to process in turn. You can track the status of
95
+
* individual placement requests by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a>. A new game session is running if the status
96
+
* is <code>FULFILLED</code> and the request returns the game session connection
97
+
* information (IP address and port). If you include player session data, Amazon GameLift creates a
98
+
* player session for each player ID in the request.</p>
99
+
* <p>The request results in a <code>BadRequestException</code> in the following
100
+
* situations:</p>
101
+
* <ul>
61
102
* <li>
62
-
* <p>(Optional) A set of player data and a unique player ID for each player that
63
-
* you are joining to the new game session (player data is optional, but if you
64
-
* include it, you must also provide a unique ID for each player)</p>
103
+
* <p>If the request includes both <i>PlayerLatencies</i> and
* <p>Latency data for all players (if you want to optimize game play for the
68
-
* players)</p>
107
+
* <p>If the request includes the <i>PriorityConfigurationOverride</i>
108
+
* parameter and designates a queue doesn't prioritize locations.</p>
69
109
* </li>
70
110
* </ul>
71
-
* <p>If successful, a new game session placement is created.</p>
72
-
* <p>To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status
73
-
* is <code>FULFILLED</code>, a new game session has been created and a game session ARN
74
-
* and Region are referenced. If the placement request times out, you can resubmit the
75
-
* request or retry it with a different queue. </p>
111
+
* <p>Amazon GameLift continues to retry each placement request until it reaches the queue's timeout
112
+
* setting. If a request times out, you can resubmit the request to the same queue or try a
113
+
* different queue. </p>
76
114
* @example
77
115
* Use a bare-bones client and the command you need to make an API call.
0 commit comments