| 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
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.
Synopsis
- data GetPlayerConnectionStatus = GetPlayerConnectionStatus' {}
- newGetPlayerConnectionStatus :: Text -> Text -> Text -> GetPlayerConnectionStatus
- getPlayerConnectionStatus_gameName :: Lens' GetPlayerConnectionStatus Text
- getPlayerConnectionStatus_playerId :: Lens' GetPlayerConnectionStatus Text
- getPlayerConnectionStatus_stageName :: Lens' GetPlayerConnectionStatus Text
- data GetPlayerConnectionStatusResponse = GetPlayerConnectionStatusResponse' {
- connections :: Maybe [Connection]
- httpStatus :: Int
- newGetPlayerConnectionStatusResponse :: Int -> GetPlayerConnectionStatusResponse
- getPlayerConnectionStatusResponse_connections :: Lens' GetPlayerConnectionStatusResponse (Maybe [Connection])
- getPlayerConnectionStatusResponse_httpStatus :: Lens' GetPlayerConnectionStatusResponse Int
Creating a Request
data GetPlayerConnectionStatus Source #
See: newGetPlayerConnectionStatus smart constructor.
Constructors
| GetPlayerConnectionStatus' | |
Instances
newGetPlayerConnectionStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> 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
| |
Instances
newGetPlayerConnectionStatusResponse Source #
Arguments
| :: Int | |
| -> 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.