| 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.DisconnectPlayer
Description
Disconnects a player from the game runtime.
If a player has multiple connections, this operation attempts to close all of them.
Synopsis
- data DisconnectPlayer = DisconnectPlayer' {}
- newDisconnectPlayer :: Text -> Text -> Text -> DisconnectPlayer
- disconnectPlayer_gameName :: Lens' DisconnectPlayer Text
- disconnectPlayer_playerId :: Lens' DisconnectPlayer Text
- disconnectPlayer_stageName :: Lens' DisconnectPlayer Text
- data DisconnectPlayerResponse = DisconnectPlayerResponse' {
- disconnectFailures :: Maybe [Text]
- disconnectSuccesses :: Maybe [Text]
- httpStatus :: Int
- newDisconnectPlayerResponse :: Int -> DisconnectPlayerResponse
- disconnectPlayerResponse_disconnectFailures :: Lens' DisconnectPlayerResponse (Maybe [Text])
- disconnectPlayerResponse_disconnectSuccesses :: Lens' DisconnectPlayerResponse (Maybe [Text])
- disconnectPlayerResponse_httpStatus :: Lens' DisconnectPlayerResponse Int
Creating a Request
data DisconnectPlayer Source #
See: newDisconnectPlayer smart constructor.
Constructors
| DisconnectPlayer' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DisconnectPlayer |
Create a value of DisconnectPlayer 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:DisconnectPlayer', disconnectPlayer_gameName - The name of the game.
$sel:playerId:DisconnectPlayer', disconnectPlayer_playerId - The unique identifier representing a player.
$sel:stageName:DisconnectPlayer', disconnectPlayer_stageName - The name of the stage.
Request Lenses
disconnectPlayer_gameName :: Lens' DisconnectPlayer Text Source #
The name of the game.
disconnectPlayer_playerId :: Lens' DisconnectPlayer Text Source #
The unique identifier representing a player.
disconnectPlayer_stageName :: Lens' DisconnectPlayer Text Source #
The name of the stage.
Destructuring the Response
data DisconnectPlayerResponse Source #
See: newDisconnectPlayerResponse smart constructor.
Constructors
| DisconnectPlayerResponse' | |
Fields
| |
Instances
newDisconnectPlayerResponse Source #
Create a value of DisconnectPlayerResponse 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:disconnectFailures:DisconnectPlayerResponse', disconnectPlayerResponse_disconnectFailures - The list of the connection ids that could not be disconnected.
$sel:disconnectSuccesses:DisconnectPlayerResponse', disconnectPlayerResponse_disconnectSuccesses - The list of the connection ids that were disconnected.
$sel:httpStatus:DisconnectPlayerResponse', disconnectPlayerResponse_httpStatus - The response's http status code.
Response Lenses
disconnectPlayerResponse_disconnectFailures :: Lens' DisconnectPlayerResponse (Maybe [Text]) Source #
The list of the connection ids that could not be disconnected.
disconnectPlayerResponse_disconnectSuccesses :: Lens' DisconnectPlayerResponse (Maybe [Text]) Source #
The list of the connection ids that were disconnected.
disconnectPlayerResponse_httpStatus :: Lens' DisconnectPlayerResponse Int Source #
The response's http status code.