amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.DescribePlayerSessions

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePlayerSessions Source #

See: newDescribePlayerSessions smart constructor.

Constructors

DescribePlayerSessions' 

Fields

  • gameSessionId :: Maybe Text

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

  • limit :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    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.

  • playerId :: Maybe Text

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

  • playerSessionId :: Maybe Text

    A unique identifier for a player session to retrieve.

  • playerSessionStatusFilter :: Maybe Text

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

Instances

Instances details
ToJSON DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

toJSON :: DescribePlayerSessions -> Value #

toEncoding :: DescribePlayerSessions -> Encoding #

toJSONList :: [DescribePlayerSessions] -> Value #

toEncodingList :: [DescribePlayerSessions] -> Encoding #

ToHeaders DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

toHeaders :: DescribePlayerSessions -> [Header] #

ToPath DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

toPath :: DescribePlayerSessions -> ByteString #

ToQuery DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

toQuery :: DescribePlayerSessions -> QueryString #

AWSPager DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

page :: DescribePlayerSessions -> AWSResponse DescribePlayerSessions -> Maybe DescribePlayerSessions #

AWSRequest DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Associated Types

type AWSResponse DescribePlayerSessions #

Methods

request :: (Service -> Service) -> DescribePlayerSessions -> Request DescribePlayerSessions #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePlayerSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePlayerSessions))) #

Generic DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Associated Types

type Rep DescribePlayerSessions :: Type -> Type #

Methods

from :: DescribePlayerSessions -> Rep DescribePlayerSessions x #

to :: Rep DescribePlayerSessions x -> DescribePlayerSessions #

Read DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

readsPrec :: Int -> ReadS DescribePlayerSessions #

readList :: ReadS [DescribePlayerSessions] #

readPrec :: ReadPrec DescribePlayerSessions #

readListPrec :: ReadPrec [DescribePlayerSessions] #

Show DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

showsPrec :: Int -> DescribePlayerSessions -> ShowS #

show :: DescribePlayerSessions -> String #

showList :: [DescribePlayerSessions] -> ShowS #

NFData DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

rnf :: DescribePlayerSessions -> () #

Eq DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

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

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

Hashable DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

hashWithSalt :: Int -> DescribePlayerSessions -> Int #

hash :: DescribePlayerSessions -> Int #

type AWSResponse DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

type AWSResponse DescribePlayerSessions = DescribePlayerSessionsResponse
type Rep DescribePlayerSessions Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

type Rep DescribePlayerSessions = D1 ('MetaData "DescribePlayerSessions" "Amazonka.GameLift.DescribePlayerSessions" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribePlayerSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gameSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "playerSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "playerSessionStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribePlayerSessions :: DescribePlayerSessions Source #

Create a value of DescribePlayerSessions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribePlayerSessions, describePlayerSessions_gameSessionId - A unique identifier for the game session to retrieve player sessions for.

$sel:limit:DescribePlayerSessions', describePlayerSessions_limit - 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.

DescribePlayerSessions, describePlayerSessions_nextToken - 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.

DescribePlayerSessions, describePlayerSessions_playerId - A unique identifier for a player to retrieve player sessions for.

DescribePlayerSessions, describePlayerSessions_playerSessionId - A unique identifier for a player session to retrieve.

$sel:playerSessionStatusFilter:DescribePlayerSessions', describePlayerSessions_playerSessionStatusFilter - 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).

Request Lenses

describePlayerSessions_gameSessionId :: Lens' DescribePlayerSessions (Maybe Text) Source #

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

describePlayerSessions_limit :: Lens' DescribePlayerSessions (Maybe Natural) Source #

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.

describePlayerSessions_nextToken :: Lens' DescribePlayerSessions (Maybe Text) Source #

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.

describePlayerSessions_playerId :: Lens' DescribePlayerSessions (Maybe Text) Source #

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

describePlayerSessions_playerSessionId :: Lens' DescribePlayerSessions (Maybe Text) Source #

A unique identifier for a player session to retrieve.

describePlayerSessions_playerSessionStatusFilter :: Lens' DescribePlayerSessions (Maybe Text) Source #

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

Destructuring the Response

data DescribePlayerSessionsResponse Source #

See: newDescribePlayerSessionsResponse smart constructor.

Constructors

DescribePlayerSessionsResponse' 

Fields

  • nextToken :: Maybe Text

    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.

  • playerSessions :: Maybe [PlayerSession]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Associated Types

type Rep DescribePlayerSessionsResponse :: Type -> Type #

Methods

from :: DescribePlayerSessionsResponse -> Rep DescribePlayerSessionsResponse x #

to :: Rep DescribePlayerSessionsResponse x -> DescribePlayerSessionsResponse #

Read DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

readsPrec :: Int -> ReadS DescribePlayerSessionsResponse #

readList :: ReadS [DescribePlayerSessionsResponse] #

readPrec :: ReadPrec DescribePlayerSessionsResponse #

readListPrec :: ReadPrec [DescribePlayerSessionsResponse] #

Show DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

showsPrec :: Int -> DescribePlayerSessionsResponse -> ShowS #

show :: DescribePlayerSessionsResponse -> String #

showList :: [DescribePlayerSessionsResponse] -> ShowS #

NFData DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

rnf :: DescribePlayerSessionsResponse -> () #

Eq DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

Methods

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

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

type Rep DescribePlayerSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribePlayerSessions

type Rep DescribePlayerSessionsResponse = D1 ('MetaData "DescribePlayerSessionsResponse" "Amazonka.GameLift.DescribePlayerSessions" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribePlayerSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "playerSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlayerSession])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePlayerSessionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribePlayerSessionsResponse'

-> DescribePlayerSessionsResponse 

Create a value of DescribePlayerSessionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribePlayerSessions, describePlayerSessionsResponse_nextToken - 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.

$sel:playerSessions:DescribePlayerSessionsResponse', describePlayerSessionsResponse_playerSessions - A collection of objects containing properties for each player session that matches the request.

$sel:httpStatus:DescribePlayerSessionsResponse', describePlayerSessionsResponse_httpStatus - The response's http status code.

Response Lenses

describePlayerSessionsResponse_nextToken :: Lens' DescribePlayerSessionsResponse (Maybe Text) Source #

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.

describePlayerSessionsResponse_playerSessions :: Lens' DescribePlayerSessionsResponse (Maybe [PlayerSession]) Source #

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

describePlayerSessionsResponse_httpStatus :: Lens' DescribePlayerSessionsResponse Int Source #

The response's http status code.