Network.AWS.GameLift.DescribePlayerSessions

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter 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.

Creating a Request

describePlayerSessions :: DescribePlayerSessions

Creates a value of DescribePlayerSessions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpsGameSessionId
• dpsNextToken
• dpsLimit
• dpsPlayerSessionId
• dpsPlayerId
• dpsPlayerSessionStatusFilter

data DescribePlayerSessions

Represents the input for a request action.

See: describePlayerSessions smart constructor.

Instances

Eq DescribePlayerSessions

Data DescribePlayerSessions

Read DescribePlayerSessions

Show DescribePlayerSessions

Generic DescribePlayerSessions

ToJSON DescribePlayerSessions

Hashable DescribePlayerSessions

AWSRequest DescribePlayerSessions

ToPath DescribePlayerSessions

ToHeaders DescribePlayerSessions

ToQuery DescribePlayerSessions

type Rep DescribePlayerSessions

type Rs DescribePlayerSessions = DescribePlayerSessionsResponse

Request Lenses

dpsGameSessionId :: Lens' DescribePlayerSessions (Maybe Text)

Unique identifier for a game session.

dpsNextToken :: Lens' DescribePlayerSessions (Maybe Text)

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

dpsLimit :: Lens' DescribePlayerSessions (Maybe Natural)

Maximum number of results to return. You can 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.

dpsPlayerSessionId :: Lens' DescribePlayerSessions (Maybe Text)

Unique identifier for a player session.

dpsPlayerId :: Lens' DescribePlayerSessions (Maybe Text)

Unique identifier for a player.

dpsPlayerSessionStatusFilter :: Lens' DescribePlayerSessions (Maybe Text)

Player session status to filter results on. Possible player session states include:

• RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
• ACTIVE: The player has been validated by the game server 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 time-out limit (60 seconds).

Destructuring the Response

describePlayerSessionsResponse

Arguments

:: Int

dpsrsResponseStatus

-> DescribePlayerSessionsResponse

Creates a value of DescribePlayerSessionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpsrsNextToken
• dpsrsPlayerSessions
• dpsrsResponseStatus

data DescribePlayerSessionsResponse

Represents the returned data in response to a request action.

See: describePlayerSessionsResponse smart constructor.

Instances

Eq DescribePlayerSessionsResponse

Data DescribePlayerSessionsResponse

Read DescribePlayerSessionsResponse

Show DescribePlayerSessionsResponse

Generic DescribePlayerSessionsResponse

type Rep DescribePlayerSessionsResponse

Response Lenses

dpsrsNextToken :: Lens' DescribePlayerSessionsResponse (Maybe Text)

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

If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.

dpsrsPlayerSessions :: Lens' DescribePlayerSessionsResponse [PlayerSession]

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

dpsrsResponseStatus :: Lens' DescribePlayerSessionsResponse Int

The response status code.