RoboMaker / Paginator / ListWorlds

ListWorlds

class RoboMaker.Paginator.ListWorlds

paginator = client.get_paginator('list_worlds')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_worlds().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  Optional filters to limit results. You can use status.

  • (dict) –

    Information about a filter.

    • name (string) –

      The name of the filter.

    • values (list) –

      A list of values.

      • (string) –

• 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

{
    'worldSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'generationJob': 'string',
            'template': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • worldSummaries (list) –

    Summary information for worlds.

    • (dict) –

      Information about a world.

      • arn (string) –

        The Amazon Resource Name (ARN) of the world.

      • createdAt (datetime) –

        The time, in milliseconds since the epoch, when the world was created.

      • generationJob (string) –

        The Amazon Resource Name (arn) of the world generation job.

      • template (string) –

        The Amazon Resource Name (arn) of the world template.

  • NextToken (string) –

    A token to resume pagination.