Network.AWS.GameLift.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:

• CreatePlayerSession
• CreatePlayerSessions
• DescribePlayerSessions
• Game session placements
• StartGameSessionPlacement
• DescribeGameSessionPlacement
• StopGameSessionPlacement

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:

• dpssGameSessionId - Unique identifier for the game session to retrieve player sessions for.
• dpssNextToken - 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.
• dpssLimit - 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.
• dpssPlayerSessionId - Unique identifier for a player session to retrieve.
• dpssPlayerId - Unique identifier for a player to retrieve player sessions for.
• dpssPlayerSessionStatusFilter - 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 andor 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 andor was not validated within the timeout limit (60 seconds).

data DescribePlayerSessions

Represents the input for a request action.

See: describePlayerSessions smart constructor.

Instances

Eq DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

(==) :: DescribePlayerSessions -> DescribePlayerSessions -> Bool

(/=) :: DescribePlayerSessions -> DescribePlayerSessions -> Bool

Data DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribePlayerSessions -> c DescribePlayerSessions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribePlayerSessions

toConstr :: DescribePlayerSessions -> Constr

dataTypeOf :: DescribePlayerSessions -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribePlayerSessions)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribePlayerSessions)

gmapT :: (forall b. Data b => b -> b) -> DescribePlayerSessions -> DescribePlayerSessions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribePlayerSessions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribePlayerSessions -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribePlayerSessions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribePlayerSessions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribePlayerSessions -> m DescribePlayerSessions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePlayerSessions -> m DescribePlayerSessions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePlayerSessions -> m DescribePlayerSessions

Read DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

readsPrec :: Int -> ReadS DescribePlayerSessions

readList :: ReadS [DescribePlayerSessions]

readPrec :: ReadPrec DescribePlayerSessions

readListPrec :: ReadPrec [DescribePlayerSessions]

Show DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

showsPrec :: Int -> DescribePlayerSessions -> ShowS

show :: DescribePlayerSessions -> String

showList :: [DescribePlayerSessions] -> ShowS

Generic DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Associated Types

type Rep DescribePlayerSessions :: Type -> Type

Methods

from :: DescribePlayerSessions -> Rep DescribePlayerSessions x

to :: Rep DescribePlayerSessions x -> DescribePlayerSessions

Hashable DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

hashWithSalt :: Int -> DescribePlayerSessions -> Int

hash :: DescribePlayerSessions -> Int

ToJSON DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

toJSON :: DescribePlayerSessions -> Value

toEncoding :: DescribePlayerSessions -> Encoding

toJSONList :: [DescribePlayerSessions] -> Value

toEncodingList :: [DescribePlayerSessions] -> Encoding

AWSRequest DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Associated Types

type Rs DescribePlayerSessions :: Type

Methods

request :: DescribePlayerSessions -> Request DescribePlayerSessions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribePlayerSessions -> ClientResponse -> m (Response DescribePlayerSessions)

ToHeaders DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

toHeaders :: DescribePlayerSessions -> [Header]

ToPath DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

toPath :: DescribePlayerSessions -> ByteString

ToQuery DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

toQuery :: DescribePlayerSessions -> QueryString

NFData DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

rnf :: DescribePlayerSessions -> ()

type Rep DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

type Rep DescribePlayerSessions = D1 (MetaData "DescribePlayerSessions" "Network.AWS.GameLift.DescribePlayerSessions" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribePlayerSessions'" PrefixI True) ((S1 (MetaSel (Just "_dpssGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dpssNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dpssLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) :*: (S1 (MetaSel (Just "_dpssPlayerSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dpssPlayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dpssPlayerSessionStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs DescribePlayerSessions

Defined in Network.AWS.GameLift.DescribePlayerSessions

type Rs DescribePlayerSessions = DescribePlayerSessionsResponse

Request Lenses

dpssGameSessionId :: Lens' DescribePlayerSessions (Maybe Text)

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

dpssNextToken :: Lens' DescribePlayerSessions (Maybe Text)

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.

dpssLimit :: Lens' DescribePlayerSessions (Maybe Natural)

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.

dpssPlayerSessionId :: Lens' DescribePlayerSessions (Maybe Text)

Unique identifier for a player session to retrieve.

dpssPlayerId :: Lens' DescribePlayerSessions (Maybe Text)

Unique identifier for a player to retrieve player sessions for.

dpssPlayerSessionStatusFilter :: Lens' DescribePlayerSessions (Maybe Text)

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 andor 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 andor was not validated within the timeout 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 - 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.
• dpsrsPlayerSessions - Collection of objects containing properties for each player session that matches the request.
• dpsrsResponseStatus - -- | The response status code.

data DescribePlayerSessionsResponse

Represents the returned data in response to a request action.

See: describePlayerSessionsResponse smart constructor.

Instances

Eq DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

(==) :: DescribePlayerSessionsResponse -> DescribePlayerSessionsResponse -> Bool

(/=) :: DescribePlayerSessionsResponse -> DescribePlayerSessionsResponse -> Bool

Data DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribePlayerSessionsResponse -> c DescribePlayerSessionsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribePlayerSessionsResponse

toConstr :: DescribePlayerSessionsResponse -> Constr

dataTypeOf :: DescribePlayerSessionsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribePlayerSessionsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribePlayerSessionsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribePlayerSessionsResponse -> DescribePlayerSessionsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribePlayerSessionsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribePlayerSessionsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribePlayerSessionsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribePlayerSessionsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribePlayerSessionsResponse -> m DescribePlayerSessionsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePlayerSessionsResponse -> m DescribePlayerSessionsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePlayerSessionsResponse -> m DescribePlayerSessionsResponse

Read DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

readsPrec :: Int -> ReadS DescribePlayerSessionsResponse

readList :: ReadS [DescribePlayerSessionsResponse]

readPrec :: ReadPrec DescribePlayerSessionsResponse

readListPrec :: ReadPrec [DescribePlayerSessionsResponse]

Show DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

showsPrec :: Int -> DescribePlayerSessionsResponse -> ShowS

show :: DescribePlayerSessionsResponse -> String

showList :: [DescribePlayerSessionsResponse] -> ShowS

Generic DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Associated Types

type Rep DescribePlayerSessionsResponse :: Type -> Type

Methods

from :: DescribePlayerSessionsResponse -> Rep DescribePlayerSessionsResponse x

to :: Rep DescribePlayerSessionsResponse x -> DescribePlayerSessionsResponse

NFData DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

Methods

rnf :: DescribePlayerSessionsResponse -> ()

type Rep DescribePlayerSessionsResponse

Defined in Network.AWS.GameLift.DescribePlayerSessions

type Rep DescribePlayerSessionsResponse = D1 (MetaData "DescribePlayerSessionsResponse" "Network.AWS.GameLift.DescribePlayerSessions" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribePlayerSessionsResponse'" PrefixI True) (S1 (MetaSel (Just "_dpsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dpsrsPlayerSessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlayerSession])) :*: S1 (MetaSel (Just "_dpsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dpsrsNextToken :: Lens' DescribePlayerSessionsResponse (Maybe Text)

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.

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.