list_stages

GameSparks.Client.list_stages(**kwargs)

Gets a paginated list of stage summaries from the game.

See also: AWS API Documentation

Request Syntax

response = client.list_stages(
    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',
    'Stages': [
        {
            'Description': 'string',
            'GameKey': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

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.

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

Exceptions

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