Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

DescribePlayerSessions

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 PlayerId 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:

Request Syntax

Copy
{ "GameSessionId": "string", "Limit": number, "NextToken": "string", "PlayerId": "string", "PlayerSessionId": "string", "PlayerSessionStatusFilter": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

GameSessionId

Unique identifier for the game session to retrieve player sessions for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9:/-]+

Required: No

Limit

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

PlayerId

Unique identifier for a player to retrieve player sessions for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

PlayerSessionId

Unique identifier for a player session to retrieve.

Type: String

Pattern: ^psess-\S+

Required: No

PlayerSessionStatusFilter

Player session status to filter results on.

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).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax

Copy
{ "NextToken": "string", "PlayerSessions": [ { "CreationTime": number, "FleetId": "string", "GameSessionId": "string", "IpAddress": "string", "PlayerData": "string", "PlayerId": "string", "PlayerSessionId": "string", "Port": number, "Status": "string", "TerminationTime": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

PlayerSessions

Collection of objects containing properties for each player session that matches the request.

Type: Array of PlayerSession objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: