GameSparks / Client / list_games

list_games#

GameSparks.Client.list_games(**kwargs)#

Gets a paginated list of games.

Request Syntax

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

Parameters:

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

{
    'Games': [
        {
            'Description': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': '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) –
- 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.

Exceptions

GameSparks.Client.exceptions.ValidationException
GameSparks.Client.exceptions.AccessDeniedException
GameSparks.Client.exceptions.ThrottlingException
GameSparks.Client.exceptions.InternalServerException