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 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 Local.
Learn more
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeGameSessions and EndDescribeGameSessions.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public abstract Task<DescribeGameSessionsResponse> DescribeGameSessionsAsync( DescribeGameSessionsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DescribeGameSessions service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5