IoTThingsGraph / Paginator / SearchSystemTemplates

SearchSystemTemplates

class IoTThingsGraph.Paginator.SearchSystemTemplates

paginator = client.get_paginator('search_system_templates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTThingsGraph.Client.search_system_templates().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (list) –

  An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

  • (dict) –

    An object that filters a system search.

    • name (string) – [REQUIRED]

      The name of the system search filter field.

    • value (list) – [REQUIRED]

      An array of string values for the search filter field. Multiple values function as AND criteria in the search.

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

{
    'summaries': [
        {
            'id': 'string',
            'arn': 'string',
            'revisionNumber': 123,
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • summaries (list) –

    An array of objects that contain summary information about each system deployment in the result set.

    • (dict) –

      An object that contains information about a system.

      • id (string) –

        The ID of the system.

      • arn (string) –

        The ARN of the system.

      • revisionNumber (integer) –

        The revision number of the system.

      • createdAt (datetime) –

        The date when the system was created.

  • NextToken (string) –

    A token to resume pagination.