class GameSparks.Paginator.ListStages
paginator = client.get_paginator('list_stages')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • GameName (string) --


    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



Response Syntax

    'Stages': [
            'Description': 'string',
            'GameKey': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'

Response Structure

  • (dict) --

    • Stages (list) --

      A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

      • (dict) --

        The summary of the properties of a stage.

        • Description (string) --

          The description of the stage.

        • GameKey (string) --

          The game key associated with the stage.

          The game key is a unique identifier that the game client uses to connect to the GameSparks backend.

        • Name (string) --

          The name of the stage.

        • State (string) --

          The state of the stage.

        • Tags (dict) --

          The tags associated with the stage.

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