Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GamesParks.GetPlayerConnectionStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the status of a player's connection to the game runtime.

It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.

Creating a Request

data GetPlayerConnectionStatus Source #

See: newGetPlayerConnectionStatus smart constructor.

Constructors

GetPlayerConnectionStatus'
Fields gameName :: Text The name of the game. playerId :: Text The unique identifier representing a player. stageName :: Text The name of the stage.

Instances

Instances details

ToHeaders GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods toHeaders :: GetPlayerConnectionStatus -> [Header] #
ToPath GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods toPath :: GetPlayerConnectionStatus -> ByteString #
ToQuery GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods toQuery :: GetPlayerConnectionStatus -> QueryString #
AWSRequest GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Associated Types type AWSResponse GetPlayerConnectionStatus # Methods request :: (Service -> Service) -> GetPlayerConnectionStatus -> Request GetPlayerConnectionStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPlayerConnectionStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPlayerConnectionStatus))) #
Generic GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Associated Types type Rep GetPlayerConnectionStatus :: Type -> Type # Methods from :: GetPlayerConnectionStatus -> Rep GetPlayerConnectionStatus x # to :: Rep GetPlayerConnectionStatus x -> GetPlayerConnectionStatus #
Read GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods readsPrec :: Int -> ReadS GetPlayerConnectionStatus # readList :: ReadS [GetPlayerConnectionStatus] # readPrec :: ReadPrec GetPlayerConnectionStatus # readListPrec :: ReadPrec [GetPlayerConnectionStatus] #
Show GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods showsPrec :: Int -> GetPlayerConnectionStatus -> ShowS # show :: GetPlayerConnectionStatus -> String # showList :: [GetPlayerConnectionStatus] -> ShowS #
NFData GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods rnf :: GetPlayerConnectionStatus -> () #
Eq GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods (==) :: GetPlayerConnectionStatus -> GetPlayerConnectionStatus -> Bool # (/=) :: GetPlayerConnectionStatus -> GetPlayerConnectionStatus -> Bool #
Hashable GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods hashWithSalt :: Int -> GetPlayerConnectionStatus -> Int # hash :: GetPlayerConnectionStatus -> Int #
type AWSResponse GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus type AWSResponse GetPlayerConnectionStatus = GetPlayerConnectionStatusResponse
type Rep GetPlayerConnectionStatus Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus type Rep GetPlayerConnectionStatus = D1 ('MetaData "GetPlayerConnectionStatus" "Amazonka.GamesParks.GetPlayerConnectionStatus" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "GetPlayerConnectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetPlayerConnectionStatus Source #

Arguments

:: Text	`$sel:gameName:GetPlayerConnectionStatus'`
-> Text	`$sel:playerId:GetPlayerConnectionStatus'`
-> Text	`$sel:stageName:GetPlayerConnectionStatus'`
-> GetPlayerConnectionStatus

Create a value of GetPlayerConnectionStatus 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:

$sel:gameName:GetPlayerConnectionStatus', getPlayerConnectionStatus_gameName - The name of the game.

$sel:playerId:GetPlayerConnectionStatus', getPlayerConnectionStatus_playerId - The unique identifier representing a player.

$sel:stageName:GetPlayerConnectionStatus', getPlayerConnectionStatus_stageName - The name of the stage.

Request Lenses

getPlayerConnectionStatus_gameName :: Lens' GetPlayerConnectionStatus Text Source #

The name of the game.

getPlayerConnectionStatus_playerId :: Lens' GetPlayerConnectionStatus Text Source #

The unique identifier representing a player.

getPlayerConnectionStatus_stageName :: Lens' GetPlayerConnectionStatus Text Source #

The name of the stage.

Destructuring the Response

data GetPlayerConnectionStatusResponse Source #

See: newGetPlayerConnectionStatusResponse smart constructor.

Constructors

GetPlayerConnectionStatusResponse'
Fields connections :: Maybe [Connection] The list of connection ids, one for each connection in use by the player. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Associated Types type Rep GetPlayerConnectionStatusResponse :: Type -> Type # Methods from :: GetPlayerConnectionStatusResponse -> Rep GetPlayerConnectionStatusResponse x # to :: Rep GetPlayerConnectionStatusResponse x -> GetPlayerConnectionStatusResponse #
Read GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods readsPrec :: Int -> ReadS GetPlayerConnectionStatusResponse # readList :: ReadS [GetPlayerConnectionStatusResponse] # readPrec :: ReadPrec GetPlayerConnectionStatusResponse # readListPrec :: ReadPrec [GetPlayerConnectionStatusResponse] #
Show GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods showsPrec :: Int -> GetPlayerConnectionStatusResponse -> ShowS # show :: GetPlayerConnectionStatusResponse -> String # showList :: [GetPlayerConnectionStatusResponse] -> ShowS #
NFData GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods rnf :: GetPlayerConnectionStatusResponse -> () #
Eq GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus Methods (==) :: GetPlayerConnectionStatusResponse -> GetPlayerConnectionStatusResponse -> Bool # (/=) :: GetPlayerConnectionStatusResponse -> GetPlayerConnectionStatusResponse -> Bool #
type Rep GetPlayerConnectionStatusResponse Source #
Instance details Defined in Amazonka.GamesParks.GetPlayerConnectionStatus type Rep GetPlayerConnectionStatusResponse = D1 ('MetaData "GetPlayerConnectionStatusResponse" "Amazonka.GamesParks.GetPlayerConnectionStatus" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "GetPlayerConnectionStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Connection])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetPlayerConnectionStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetPlayerConnectionStatusResponse'`
-> GetPlayerConnectionStatusResponse

Create a value of GetPlayerConnectionStatusResponse 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:

$sel:connections:GetPlayerConnectionStatusResponse', getPlayerConnectionStatusResponse_connections - The list of connection ids, one for each connection in use by the player.

$sel:httpStatus:GetPlayerConnectionStatusResponse', getPlayerConnectionStatusResponse_httpStatus - The response's http status code.

Response Lenses

getPlayerConnectionStatusResponse_connections :: Lens' GetPlayerConnectionStatusResponse (Maybe [Connection]) Source #

The list of connection ids, one for each connection in use by the player.

getPlayerConnectionStatusResponse_httpStatus :: Lens' GetPlayerConnectionStatusResponse Int Source #

The response's http status code.