AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
This operation is not designed to be continually called to track game session status.
This practice can cause you to exceed your API limit, which results in errors. Instead,
you must configure configure an Amazon Simple Notification Service (SNS) topic to
receive notifications from FlexMatch or queues. Continuously polling game session
DescribeGameSessions should only be used for games in development
with low game session usage.
When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.
This operation can be used in the following ways:
To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSession object is returned for each game session
that matches the request. Search finds game sessions that are in
status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's
GameProperty values are stored as key:value pairs; the filter
expression must indicate the key and a string to search the data values for. For example,
to search for game sessions with custom data containing the key:value pair "gameMode:brawl",
specify the following:
gameSessionProperties.gameMode = "brawl". All
custom data values are searched as strings.
maximumSessions -- Maximum number of player sessions allowed for a game session.
creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.
playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
Returned values for
change quickly as players join sessions and others drop out. Results should be considered
a snapshot in time. Be sure to refresh search results often, and handle sessions that
fill up before a player can join.
For .NET Core this operation is only available in asynchronous form. Please refer to SearchGameSessionsAsync.
public abstract SearchGameSessionsResponse SearchGameSessions( SearchGameSessionsRequest request )
Container for the necessary parameters to execute the SearchGameSessions service method.
|InternalServiceException||The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.|
|InvalidRequestException||One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.|
|NotFoundException||THe requested resources was not found. The resource was either not created yet or deleted.|
|TerminalRoutingStrategyException||The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.|
|UnauthorizedException||The client failed authentication. Clients should not retry such requests.|
|UnsupportedRegionException||The requested operation is not supported in the Region specified.|
Supported in: 4.5, 4.0, 3.5