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
* <p>Retrieves all active game sessions that match a set of search criteria and sorts them
45
45
* into a specified order. </p>
46
-
* <p>This operation is not designed to be continually called to track game session status.
47
-
* This practice can cause you to exceed your API limit, which results in errors. Instead,
48
-
* you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
49
-
* FlexMatch or queues. Continuously polling game session status with
50
-
* <code>DescribeGameSessions</code> should only be used for games in development with
51
-
* low game session usage. </p>
46
+
* <p>This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or game session placement queue.</p>
52
47
* <p>When searching for game sessions, you specify exactly where you want to search and
53
48
* provide a search filter expression, a sort expression, or both. A search request can
54
49
* search only one fleet, but it can search all of a fleet's locations. </p>
* <p>If successful, a <code>GameSession</code> object is returned for each game session
71
66
* that matches the request. Search finds game sessions that are in <code>ACTIVE</code>
72
67
* status only. To retrieve information on game sessions in other statuses, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html">DescribeGameSessions</a> .</p>
73
-
* <p>You can search or sort by the following game session attributes:</p>
68
+
* <p>To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.</p>
* <b>gameSessionProperties</b> -- Custom data defined
88
-
* in a game session's <code>GameProperty</code> parameter.
89
-
* <code>GameProperty</code> values are stored as key:value pairs; the filter
90
-
* expression must indicate the key and a string to search the data values for. For
91
-
* example, to search for game sessions with custom data containing the key:value
92
-
* pair "gameMode:brawl", specify the following:
93
-
* <code>gameSessionProperties.gameMode = "brawl"</code>. All custom data
94
-
* values are searched as strings.</p>
82
+
* <b>gameSessionProperties</b> -- A set of key-value pairs that can store custom data in a game session.
83
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
84
+
* The filter expression must specify the <a>GameProperty</a> -- a <code>Key</code> and a string <code>Value</code> to search for the game sessions.</p>
85
+
* <p>For example, to search for the above key-value pair, specify the following search filter: <code>gameSessionProperties.difficulty = "novice"</code>.
86
+
* All game property values are searched as strings.</p>
87
+
* <p>
88
+
* For examples of searching game sessions, see the ones below, and also see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search">Search game sessions by game property</a>.
* <p>Set of key-value pairs that contain information about a game session. When included in
2881
-
* a game session request, these properties communicate details to be used when setting up
2882
-
* the new game session. For example, a game property might specify a game mode, level, or
2883
-
* map. Game properties are passed to the game server process when initiating a new game
2884
-
* session. For more information, see the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create"> Amazon GameLift Developer Guide</a>.</p>
2880
+
* <p>This key-value pair can store custom data about a game session.
2881
+
* For example, you might use a <code>GameProperty</code> to track a game session's map, level of difficulty, or remaining time.
2882
+
* The difficulty level could be specified like this: <code>\{"Key": "difficulty", "Value":"Novice"\}</code>.
2883
+
* </p>
2884
+
* <p>
2885
+
* You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.
2886
+
* </p>
2887
+
* <p>For examples of working with game properties, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties">Create a game session with properties</a>.
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
2937
+
* <p>A set of key-value pairs that can store custom data in a game session.
2938
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
2939
+
* For an example, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create">Create a game session with custom properties</a>.
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
3126
+
* <p>A set of key-value pairs that can store custom data in a game session.
3127
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.</p>
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is
3726
+
* <p>A set of key-value pairs that can store custom data in a game session.
3727
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>. This information is added to the new <code>GameSession</code> object that is
3719
3728
* created for a successful match. This parameter is not used if <code>FlexMatchMode</code>
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is
3884
+
* <p>A set of key-value pairs that can store custom data in a game session.
3885
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>. This information is added to the new <code>GameSession</code> object that is
3876
3886
* created for a successful match. This parameter is not used when
3877
3887
* <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
3878
3888
*/
@@ -5466,18 +5476,19 @@ export interface Event {
5466
5476
* </li>
5467
5477
* <li>
5468
5478
* <p>SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call
5469
-
* InitSDK() within the time expected. Check your game session log to see why
5470
-
* InitSDK() was not called in time.</p>
5479
+
* <code>InitSDK()</code> within the time expected (5 minutes). Check your game
5480
+
* session log to see why <code>InitSDK()</code> was not called in time.</p>
5471
5481
* </li>
5472
5482
* <li>
5473
5483
* <p>SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call
5474
-
* ProcessReady() within the time expected after calling InitSDK(). Check your game
5475
-
* session log to see why ProcessReady() was not called in time.</p>
5484
+
* <code>ProcessReady()</code> within the time expected (5 minutes) after
5485
+
* calling <code>InitSDK()</code>. Check your game session log to see why
5486
+
* <code>ProcessReady()</code> was not called in time.</p>
5476
5487
* </li>
5477
5488
* <li>
5478
5489
* <p>SERVER_PROCESS_CRASHED -- The server process exited without calling
5479
-
* ProcessEnding(). Check your game session log to see why ProcessEnding() was not
5480
-
* called.</p>
5490
+
* <code>ProcessEnding()</code>. Check your game session log to see why
5491
+
* <code>ProcessEnding()</code> was not called.</p>
5481
5492
* </li>
5482
5493
* <li>
5483
5494
* <p>SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a
@@ -5487,13 +5498,14 @@ export interface Event {
5487
5498
* </li>
5488
5499
* <li>
5489
5500
* <p>SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly
5490
-
* after OnProcessTerminate() was sent within the time expected. Check your game
5491
-
* session log to see why termination took longer than expected.</p>
5501
+
* within the time expected after <code>OnProcessTerminate()</code> was sent. Check
5502
+
* your game session log to see why termination took longer than expected.</p>
5492
5503
* </li>
5493
5504
* <li>
5494
5505
* <p>SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly
5495
-
* within the time expected after calling ProcessEnding(). Check your game session
5496
-
* log to see why termination took longer than expected.</p>
5506
+
* within the time expected (30 seconds) after calling
5507
+
* <code>ProcessEnding()</code>. Check your game session log to see why termination
5508
+
* took longer than expected.</p>
5497
5509
* </li>
5498
5510
* </ul>
5499
5511
* <p>
@@ -5502,8 +5514,9 @@ export interface Event {
5502
5514
* <ul>
5503
5515
* <li>
5504
5516
* <p>GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the
5505
-
* expected time. Check your game session log to see why ActivateGameSession() took
5506
-
* longer to complete than expected.</p>
5517
+
* expected time. Check your game session log to see why
5518
+
* <code>ActivateGameSession()</code> took longer to complete than
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
6305
+
* <p>A set of key-value pairs that can store custom data in a game session.
6306
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.</p>
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
9027
+
* <p>A set of key-value pairs that can store custom data in a game session.
9028
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.</p>
* <p>A set of key-value pairs that can store custom data in a game session.
336
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
337
+
* You can use this parameter to modify game properties in an active game session.
338
+
* This action adds new properties and modifies existing properties.
339
+
* There is no way to delete properties.
340
+
* For an example, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update">Update the value of a game property</a>.
* <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is
513
+
* <p>A set of key-value pairs that can store custom data in a game session.
514
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>. This information is added to the new <code>GameSession</code> object that is
502
515
* created for a successful match. This parameter is not used if <code>FlexMatchMode</code>
0 commit comments