Container for the parameters to the DescribePlayerSessions operation.
Retrieves properties for one or more player sessions. This action can be used in several
ways: (1) provide a
PlayerSessionId to request properties for a specific
player session; (2) provide a
GameSessionId to request properties for
all player sessions in the specified game session; (3) provide a
to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
Available in Amazon GameLift Local.
Player-session-related operations include:
public class DescribePlayerSessionsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DescribePlayerSessionsRequest type exposes the following members
Gets and sets the property GameSessionId.
Unique identifier for the game session to retrieve player sessions for.
Gets and sets the property Limit.
Maximum number of results to return. Use this parameter with
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. If a player session ID is specified, this parameter is ignored.
Gets and sets the property PlayerId.
Unique identifier for a player to retrieve player sessions for.
Gets and sets the property PlayerSessionId.
Unique identifier for a player session to retrieve.
Gets and sets the property PlayerSessionStatusFilter.
Player session status to filter results on.
Possible player session statuses include the following:
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms