update_game_configuration

GameSparks.Client.update_game_configuration(**kwargs)

Updates one or more sections of the game configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_game_configuration(
    GameName='string',
    Modifications=[
        {
            'Operation': 'ADD'|'REMOVE'|'REPLACE',
            'Path': 'string',
            'Section': 'string',
            'Value': {...}|[...]|123|123.4|'string'|True|None
        },
    ]
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Modifications (list) --

    [REQUIRED]

    The list of modifications to make.

    • (dict) --

      A single modification to the configuration section.

      • Operation (string) -- [REQUIRED]

        The operation to be performed on a configuration section.

        Content can be added, deleted, or replaced within a section.

      • Path (string) -- [REQUIRED]

        The path within the section content to be modified.

      • Section (string) -- [REQUIRED]

        The name of the section to be modified.

      • Value (document) --

        For add and replace operations, this is the value that will be used.

        This field should be omitted for delete operations.

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
  • GameSparks.Client.exceptions.ServiceQuotaExceededException