Container for the parameters to the DescribeGameSessions operation. 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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.DescribeGameSessionsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class DescribeGameSessionsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DescribeGameSessionsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeGameSessionsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AliasId | System.String |
Gets and sets the property AliasId. A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value. |
|
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. |
|
|
GameSessionId | System.String |
Gets and sets the property GameSessionId. A unique identifier for the game session to retrieve. |
|
|
Limit | System.Int32 |
Gets and sets the property Limit.
The maximum number of results to return. Use this parameter with |
|
|
Location | System.String |
Gets and sets the property Location.
A fleet location to get game sessions for. You can specify a fleet's home Region or
a remote location. Use the Amazon Web Services Region code format, such as |
|
|
NextToken | System.String |
Gets and sets the property NextToken. A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. |
|
|
StatusFilter | System.String |
Gets and sets the property StatusFilter.
Game session status to filter results on. You can filter on the following states:
|
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5