get_player_connection_status

get_player_connection_status(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_player_connection_status(
    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

{
    'Connections': [
        {
            'Created': datetime(2015, 1, 1),
            'Id': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Connections (list) --

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

      • (dict) --

        Details about a WebSocket connection.

        • Created (datetime) --

          The date and time when the connection was created.

        • Id (string) --

          The identifier used to indicate a specific WebSocket connection.

Exceptions

  • GameSparks.Client.exceptions.ValidationException
  • GameSparks.Client.exceptions.AccessDeniedException
  • GameSparks.Client.exceptions.ThrottlingException
  • GameSparks.Client.exceptions.ResourceNotFoundException
  • GameSparks.Client.exceptions.InternalServerException