AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the DescribeGameSessions operation. Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Available in Amazon GameLift Local.

Game-session-related operations include:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.DescribeGameSessionsRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeGameSessionsRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The DescribeGameSessionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AliasId System.String

Gets and sets the property AliasId.

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet to retrieve all game sessions for.

Public Property GameSessionId System.String

Gets and sets the property GameSessionId.

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Public Property Limit System.Int32

Gets and sets the property Limit.

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Public Property NextToken System.String

Gets and sets the property NextToken.

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Public Property StatusFilter System.String

Gets and sets the property StatusFilter.

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms