GameSparks / Paginator / ListGames

ListGames#

class GameSparks.Paginator.ListGames#

paginator = client.get_paginator('list_games')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

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

{
    'Games': [
        {
            'Description': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

(dict) –
- Games (list) –
  
  The list of games.
  - (dict) –
    
    The summary of the properties of a game.
    - Description (string) –
      
      The description of the game.
    - Name (string) –
      
      The name of the game.
    - State (string) –
      
      The state of the game.
    - Tags (dict) –
      
      The tags associated with the game.
      - (string) –
        
        (string) –