DescribePlayerSessionsRequest Class

Container for the parameters to the DescribePlayerSessions operation. Retrieves properties for one or more player sessions.

This action can be used in the following ways:

To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific PlayerSessionId or PlayerId, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Related actions

All APIs by task

Inheritance Hierarchy

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

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

Syntax

public class DescribePlayerSessionsRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The DescribePlayerSessionsRequest type exposes the following members

Constructors

	Name	Description
	DescribePlayerSessionsRequest()

Properties

Name	Type	Description
GameSessionId	System.String	Gets and sets the property GameSessionId. A unique identifier for the game session to retrieve player sessions for.
Limit	System.Int32	Gets and sets the property Limit. The maximum number of results to return. Use this parameter with `NextToken` to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
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. If a player session ID is specified, this parameter is ignored.
PlayerId	System.String	Gets and sets the property PlayerId. A unique identifier for a player to retrieve player sessions for.
PlayerSessionId	System.String	Gets and sets the property PlayerSessionId. A unique identifier for a player session to retrieve.
PlayerSessionStatusFilter	System.String	Gets and sets the property PlayerSessionStatusFilter. Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response. Possible player session statuses include the following: RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. ACTIVE -- The player has been validated by the server process and is currently connected. COMPLETED -- The player connection has been dropped. TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

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