IoT / Paginator / ListThings

ListThings

class IoT.Paginator.ListThings

paginator = client.get_paginator('list_things')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_things().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    attributeName='string',
    attributeValue='string',
    thingTypeName='string',
    usePrefixAttributeValue=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• attributeName (string) – The attribute name used to search for things.

• attributeValue (string) – The attribute value used to search for things.

• thingTypeName (string) – The name of the thing type used to search for things.

• usePrefixAttributeValue (boolean) –

  When true , the action returns the thing resources with attribute values that start with the attributeValue provided.

  When false , or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

• 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': [
        {
            'thingName': 'string',
            'thingTypeName': 'string',
            'thingArn': 'string',
            'attributes': {
                'string': 'string'
            },
            'version': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The output from the ListThings operation.

  • things (list) –

    The things.

    • (dict) –

      The properties of the thing, including thing name, thing type name, and a list of thing attributes.

      • thingName (string) –

        The name of the thing.

      • thingTypeName (string) –

        The name of the thing type, if the thing has been associated with a type.

      • thingArn (string) –

        The thing ARN.

      • attributes (dict) –

        A list of thing attributes which are name-value pairs.

        • (string) –

          • (string) –

      • version (integer) –

        The version of the thing record in the registry.

  • NextToken (string) –

    A token to resume pagination.