get_snapshot

get_snapshot(**kwargs)

Gets a copy of the game configuration in a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_snapshot(
    GameName='string',
    Sections=[
        'string',
    ],
    SnapshotId='string'
)

Parameters

• GameName (string) --

  [REQUIRED]

  The name of the game.

• Sections (list) --

  The list of game configuration sections to be described.

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

  [REQUIRED]

  The identifier of the snapshot.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • Snapshot (dict) --

    Properties that provide details of the snapshot.

    • Created (datetime) --

      The timestamp of when the snapshot was created.

    • Description (string) --

      The description of the snapshot.

    • Id (string) --

      The identifier of the snapshot.

    • LastUpdated (datetime) --

      The timestamp of when the snapshot was last updated.

    • Sections (dict) --

      The sections in the snapshot.

      • (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