IoTThingsGraph / Paginator / SearchThings

SearchThings

class IoTThingsGraph.Paginator.SearchThings

paginator = client.get_paginator('search_things')

paginate(**kwargs)

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

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(
    entityId='string',
    namespaceVersion=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• entityId (string) –

  [REQUIRED]

  The ID of the entity to which the things are associated.

  The IDs should be in the following format.

  urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

• namespaceVersion (integer) – The version of the user’s namespace. Defaults to the latest version of the user’s namespace.

• 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

{
    'things': [
        {
            'thingArn': 'string',
            'thingName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • things (list) –

    An array of things in the result set.

    • (dict) –

      An AWS IoT thing.

      • thingArn (string) –

        The ARN of the thing.

      • thingName (string) –

        The name of the thing.

  • NextToken (string) –

    A token to resume pagination.