Container for the parameters to the DescribeGameSessionDetails operation. Retrieves additional game session properties, including the game session protection policy in force, 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 details for 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 details from the fleet's home Region and all remote locations.
-
To retrieve details for 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 details for 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 GameSessionDetail object is returned for each game session
that matches the request.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.DescribeGameSessionDetailsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class DescribeGameSessionDetailsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DescribeGameSessionDetailsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeGameSessionDetailsRequest() |
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 all 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 all game sessions active on the fleet. 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 session details 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. Possible game session statuses include |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5