Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describePlayerSessions :: DescribePlayerSessions
- data DescribePlayerSessions
- dpsGameSessionId :: Lens' DescribePlayerSessions (Maybe Text)
- dpsNextToken :: Lens' DescribePlayerSessions (Maybe Text)
- dpsLimit :: Lens' DescribePlayerSessions (Maybe Natural)
- dpsPlayerSessionId :: Lens' DescribePlayerSessions (Maybe Text)
- dpsPlayerId :: Lens' DescribePlayerSessions (Maybe Text)
- dpsPlayerSessionStatusFilter :: Lens' DescribePlayerSessions (Maybe Text)
- describePlayerSessionsResponse :: Int -> DescribePlayerSessionsResponse
- data DescribePlayerSessionsResponse
- dpsrsNextToken :: Lens' DescribePlayerSessionsResponse (Maybe Text)
- dpsrsPlayerSessions :: Lens' DescribePlayerSessionsResponse [PlayerSession]
- dpsrsResponseStatus :: Lens' DescribePlayerSessionsResponse Int
Creating a Request
describePlayerSessions :: DescribePlayerSessions Source #
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:
data DescribePlayerSessions Source #
Represents the input for a request action.
See: describePlayerSessions
smart constructor.
Request Lenses
dpsGameSessionId :: Lens' DescribePlayerSessions (Maybe Text) Source #
Unique identifier for a game session.
dpsNextToken :: Lens' DescribePlayerSessions (Maybe Text) Source #
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) Source #
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) Source #
Unique identifier for a player session.
dpsPlayerId :: Lens' DescribePlayerSessions (Maybe Text) Source #
Unique identifier for a player.
dpsPlayerSessionStatusFilter :: Lens' DescribePlayerSessions (Maybe Text) Source #
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 Source #
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:
data DescribePlayerSessionsResponse Source #
Represents the returned data in response to a request action.
See: describePlayerSessionsResponse
smart constructor.
Response Lenses
dpsrsNextToken :: Lens' DescribePlayerSessionsResponse (Maybe Text) Source #
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] Source #
Collection of objects containing properties for each player session that matches the request.
dpsrsResponseStatus :: Lens' DescribePlayerSessionsResponse Int Source #
The response status code.