Amazonka.GamesParks.DisconnectPlayer

Disconnects a player from the game runtime.

If a player has multiple connections, this operation attempts to close all of them.

Creating a Request

data DisconnectPlayer

See: newDisconnectPlayer smart constructor.

Constructors

DisconnectPlayer'

Fields

• gameName :: Text

  The name of the game.

• playerId :: Text

  The unique identifier representing a player.

• stageName :: Text

  The name of the stage.

Instances

ToJSON DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

toJSON :: DisconnectPlayer -> Value

toEncoding :: DisconnectPlayer -> Encoding

toJSONList :: [DisconnectPlayer] -> Value

toEncodingList :: [DisconnectPlayer] -> Encoding

ToHeaders DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

toHeaders :: DisconnectPlayer -> [Header]

ToPath DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

toPath :: DisconnectPlayer -> ByteString

ToQuery DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

toQuery :: DisconnectPlayer -> QueryString

AWSRequest DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Associated Types

type AWSResponse DisconnectPlayer

Methods

request :: (Service -> Service) -> DisconnectPlayer -> Request DisconnectPlayer

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

Generic DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Associated Types

type Rep DisconnectPlayer :: Type -> Type

Methods

from :: DisconnectPlayer -> Rep DisconnectPlayer x

to :: Rep DisconnectPlayer x -> DisconnectPlayer

Read DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

readsPrec :: Int -> ReadS DisconnectPlayer

readList :: ReadS [DisconnectPlayer]

readPrec :: ReadPrec DisconnectPlayer

readListPrec :: ReadPrec [DisconnectPlayer]

Show DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

showsPrec :: Int -> DisconnectPlayer -> ShowS

show :: DisconnectPlayer -> String

showList :: [DisconnectPlayer] -> ShowS

NFData DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

rnf :: DisconnectPlayer -> ()

Eq DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

(==) :: DisconnectPlayer -> DisconnectPlayer -> Bool

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

Hashable DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

hashWithSalt :: Int -> DisconnectPlayer -> Int

hash :: DisconnectPlayer -> Int

type AWSResponse DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

type AWSResponse DisconnectPlayer = DisconnectPlayerResponse

type Rep DisconnectPlayer

Defined in Amazonka.GamesParks.DisconnectPlayer

type Rep DisconnectPlayer = D1 ('MetaData "DisconnectPlayer" "Amazonka.GamesParks.DisconnectPlayer" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "DisconnectPlayer'" '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))))

newDisconnectPlayer

Arguments

:: Text

$sel:gameName:DisconnectPlayer'

-> Text

$sel:playerId:DisconnectPlayer'

-> Text

$sel:stageName:DisconnectPlayer'

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

The name of the game.

disconnectPlayer_playerId :: Lens' DisconnectPlayer Text

The unique identifier representing a player.

disconnectPlayer_stageName :: Lens' DisconnectPlayer Text

The name of the stage.

Destructuring the Response

data DisconnectPlayerResponse

See: newDisconnectPlayerResponse smart constructor.

Constructors

DisconnectPlayerResponse'

Fields

• disconnectFailures :: Maybe [Text]

  The list of the connection ids that could not be disconnected.

• disconnectSuccesses :: Maybe [Text]

  The list of the connection ids that were disconnected.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

Associated Types

type Rep DisconnectPlayerResponse :: Type -> Type

Methods

from :: DisconnectPlayerResponse -> Rep DisconnectPlayerResponse x

to :: Rep DisconnectPlayerResponse x -> DisconnectPlayerResponse

Read DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

readsPrec :: Int -> ReadS DisconnectPlayerResponse

readList :: ReadS [DisconnectPlayerResponse]

readPrec :: ReadPrec DisconnectPlayerResponse

readListPrec :: ReadPrec [DisconnectPlayerResponse]

Show DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

showsPrec :: Int -> DisconnectPlayerResponse -> ShowS

show :: DisconnectPlayerResponse -> String

showList :: [DisconnectPlayerResponse] -> ShowS

NFData DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

rnf :: DisconnectPlayerResponse -> ()

Eq DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

Methods

(==) :: DisconnectPlayerResponse -> DisconnectPlayerResponse -> Bool

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

type Rep DisconnectPlayerResponse

Defined in Amazonka.GamesParks.DisconnectPlayer

type Rep DisconnectPlayerResponse = D1 ('MetaData "DisconnectPlayerResponse" "Amazonka.GamesParks.DisconnectPlayer" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "DisconnectPlayerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disconnectFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "disconnectSuccesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDisconnectPlayerResponse

Arguments

:: Int

$sel:httpStatus:DisconnectPlayerResponse'

-> DisconnectPlayerResponse

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

The list of the connection ids that could not be disconnected.

disconnectPlayerResponse_disconnectSuccesses :: Lens' DisconnectPlayerResponse (Maybe [Text])

The list of the connection ids that were disconnected.

disconnectPlayerResponse_httpStatus :: Lens' DisconnectPlayerResponse Int

The response's http status code.