get_game

GameSparks.Client.get_game(**kwargs)

Gets details about a game.

See also: AWS API Documentation

Request Syntax

response = client.get_game(
    GameName='string'
)

Parameters

GameName (string) --

[REQUIRED]

The name of the game.

Return type

dict

Returns

Response Syntax

{
    'Game': {
        'Arn': 'string',
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'EnableTerminationProtection': True|False,
        'LastUpdated': datetime(2015, 1, 1),
        'Name': 'string',
        'State': 'ACTIVE'|'DELETING',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --
  • Game (dict) --

    The details of the game.

    • Arn (string) --

      The Amazon Resource Name (ARN) of this game.

    • Created (datetime) --

      The date when the game was created.

    • Description (string) --

      The description of the game.

    • EnableTerminationProtection (boolean) --

      Determines if the game can be deleted.

    • LastUpdated (datetime) --

      The date when the game was last modified.

    • Name (string) --

      The name of the game.

    • State (string) --

      The state of the game.

    • Tags (dict) --

      The tags associated with the game.

      • (string) --
        • (string) --

Exceptions

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