GameSparks / Paginator / ListSnapshots

ListSnapshots

class GameSparks.Paginator.ListSnapshots

paginator = client.get_paginator('list_snapshots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GameName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GameName (string) –

  [REQUIRED]

  The name of the game.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Snapshots': [
        {
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'LastUpdated': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • Snapshots (list) –

    A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

    • (dict) –

      The summary of the properties of a 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) –

        Then timestamp of when the snapshot was last updated.