GameSparks / Client / list_snapshots

list_snapshots

GameSparks.Client.list_snapshots(**kwargs)

Gets a paginated list of snapshot summaries from the game.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshots(
    GameName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• GameName (string) –

  [REQUIRED]

  The name of the game.

• MaxResults (integer) –

  The maximum number of results to return.

  Use this parameter with NextToken to get results as a set of sequential pages.

• NextToken (string) –

  The token that indicates the start of the next sequential page of results.

  Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • NextToken (string) –

    The token that indicates the start of the next sequential page of results.

    Use this value when making the next call to this operation to continue where the last one finished.

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

Exceptions

• GameSparks.Client.exceptions.ValidationException

• GameSparks.Client.exceptions.AccessDeniedException

• GameSparks.Client.exceptions.ThrottlingException

• GameSparks.Client.exceptions.ResourceNotFoundException

• GameSparks.Client.exceptions.InternalServerException