RoboMaker / Paginator / ListWorldTemplates

ListWorldTemplates#

class RoboMaker.Paginator.ListWorldTemplates#
paginator = client.get_paginator('list_world_templates')
paginate(**kwargs)#

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

See also: AWS API Documentation

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

{
    'templateSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • templateSummaries (list) –

      Summary information for templates.

      • (dict) –

        Summary information for a template.

        • arn (string) –

          The Amazon Resource Name (ARN) of the template.

        • createdAt (datetime) –

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

        • lastUpdatedAt (datetime) –

          The time, in milliseconds since the epoch, when the template was last updated.

        • name (string) –

          The name of the template.

        • version (string) –

          The version of the template that you’re using.

    • NextToken (string) –

      A token to resume pagination.