Post x amz targetgamelift.describeplayersessions

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

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

post/#X-Amz-Target=GameLift.DescribePlayerSessions

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'GameLift.DescribePlayerSessions' required

Request body

GameSessionIdstring

A unique identifier for the game session to retrieve player sessions for.

PlayerIdstring

A unique identifier for a player to retrieve player sessions for.

PlayerSessionIdstring

A unique identifier for a player session to retrieve.

PlayerSessionStatusFilterstring

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: <ul> <li> RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. </li> <li> ACTIVE -- The player has been validated by the server process and is currently connected. </li> <li> COMPLETED -- The player connection has been dropped. </li> <li> TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds). </li> </ul>

Limitinteger

The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

NextTokenstring

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.

Response

Success

NextTokenstring

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