GameSparks / Client / disconnect_player

disconnect_player

GameSparks.Client.disconnect_player(**kwargs)

Disconnects a player from the game runtime.

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

See also: AWS API Documentation

Request Syntax

response = client.disconnect_player(
    GameName='string',
    PlayerId='string',
    StageName='string'
)

Parameters:

• GameName (string) –

  [REQUIRED]

  The name of the game.

• PlayerId (string) –

  [REQUIRED]

  The unique identifier representing a player.

• StageName (string) –

  [REQUIRED]

  The name of the stage.

Return type:

dict

Returns:

Response Syntax

{
    'DisconnectFailures': [
        'string',
    ],
    'DisconnectSuccesses': [
        'string',
    ]
}

Response Structure

• (dict) –

  • DisconnectFailures (list) –

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

    • (string) –

  • DisconnectSuccesses (list) –

    The list of the connection ids that were disconnected.

    • (string) –

Exceptions

• GameSparks.Client.exceptions.ValidationException

• GameSparks.Client.exceptions.AccessDeniedException

• GameSparks.Client.exceptions.ThrottlingException

• GameSparks.Client.exceptions.ResourceNotFoundException

• GameSparks.Client.exceptions.InternalServerException