GameSparks / Client / get_game_configuration

get_game_configuration#

GameSparks.Client.get_game_configuration(**kwargs)#

Gets the configuration of the game.

See also: AWS API Documentation

Request Syntax

response = client.get_game_configuration(
    GameName='string',
    Sections=[
        'string',
    ]
)
Parameters:
  • GameName (string) –

    [REQUIRED]

    The name of the game.

  • Sections (list) –

    The list of sections to return.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'GameConfiguration': {
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) –

    • GameConfiguration (dict) –

      Details about the game configuration.

      • Created (datetime) –

        The date when the game was created.

      • LastUpdated (datetime) –

        The date when the game was last modified.

      • Sections (dict) –

        Configuration data, organized by section name.

        • (string) –

          • (dict) –

            The configuration section.

            • Attributes (document) –

              The content of a configuration section.

            • Name (string) –

              The name of the section.

            • Size (integer) –

              The size, in bytes, of the section contents.

Exceptions

  • GameSparks.Client.exceptions.ValidationException

  • GameSparks.Client.exceptions.AccessDeniedException

  • GameSparks.Client.exceptions.ThrottlingException

  • GameSparks.Client.exceptions.ResourceNotFoundException

  • GameSparks.Client.exceptions.InternalServerException