DescribeGameSessions (smaws-clients.Smaws_Client

Module Smaws_Client_GameLift.DescribeGameSessions

This 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

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServiceException of Types.internal_service_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `NotFoundException of Types.not_found_exception
  | `TerminalRoutingStrategyException of
    Types.terminal_routing_strategy_exception
  | `UnauthorizedException of Types.unauthorized_exception
  | `UnsupportedRegionException of Types.unsupported_region_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_game_sessions_input ->
  (Types.describe_game_sessions_output,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `TerminalRoutingStrategyException of
      Types.terminal_routing_strategy_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_game_sessions_input ->
  (Types.describe_game_sessions_output Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `TerminalRoutingStrategyException of
      Types.terminal_routing_strategy_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result