Skip to content

/AWS1/CL_GML=>DESCRIBEPLAYERSESSIONS()

About DescribePlayerSessions

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

Method Signature

IMPORTING

Optional arguments:

IV_GAMESESSIONID TYPE /AWS1/GMLARNSTRINGMODEL /AWS1/GMLARNSTRINGMODEL

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

IV_PLAYERID TYPE /AWS1/GMLPLAYERID /AWS1/GMLPLAYERID

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

IV_PLAYERSESSIONID TYPE /AWS1/GMLPLAYERSESSIONID /AWS1/GMLPLAYERSESSIONID

A unique identifier for a player session to retrieve.

IV_PLAYERSESSIONSTATUSFILTER TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

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

IV_LIMIT TYPE /AWS1/GMLPOSITIVEINTEGER /AWS1/GMLPOSITIVEINTEGER

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.

IV_NEXTTOKEN TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLDSCPLAYERSESSSOUT /AWS1/CL_GMLDSCPLAYERSESSSOUT