Values.DescribeGameSessionsOutputSourceThis API works with the following fleet types: EC2, Anywhere, Container Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. This operation can be used in the following ways: To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations. To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location. To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request. 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. 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 an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage. Available in Amazon GameLift Servers Local. Learn more Find a game session All APIs by task
type nonrec t = {gameSessions : GameSessionList.t option;A collection of properties for each game session that matches the request.
*)nextToken : NonZeroAndMaxString.t option;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.
*)}type nonrec error = [ | `InternalServiceException of InternalServiceException.t| `InvalidRequestException of InvalidRequestException.t| `NotFoundException of NotFoundException.t| `TerminalRoutingStrategyException of TerminalRoutingStrategyException.t| `UnsupportedRegionException of UnsupportedRegionException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `InternalServiceException of InternalServiceException.t
| `InvalidRequestException of InvalidRequestException.t
| `NotFoundException of NotFoundException.t
| `TerminalRoutingStrategyException of TerminalRoutingStrategyException.t
| `UnauthorizedException of UnauthorizedException.t
| `Unknown_operation_error of string * string option
| `UnsupportedRegionException of UnsupportedRegionException.t ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `InternalServiceException of InternalServiceException.t
| `InvalidRequestException of InvalidRequestException.t
| `NotFoundException of NotFoundException.t
| `TerminalRoutingStrategyException of TerminalRoutingStrategyException.t
| `UnauthorizedException of UnauthorizedException.t
| `Unknown_operation_error of string * string option
| `UnsupportedRegionException of UnsupportedRegionException.t ]val to_value :
t ->
[> `Structure of
(string
* [> `List of
[> `Structure of
(string
* [> `Enum of string
| `Integer of WholeNumber.t
| `List of
[> `Structure of
(string * [> `String of GamePropertyKey.t ]) list ]
list
| `String of NonZeroAndMaxString.t
| `Timestamp of Timestamp.t ])
list ]
list
| `String of NonZeroAndMaxString.t ])
list ]