IoT / Paginator / ListThingTypes

ListThingTypes#

class IoT.Paginator.ListThingTypes#
paginator = client.get_paginator('list_thing_types')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingTypeName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • thingTypeName (string) – The name of the thing type.

  • 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

{
    'thingTypes': [
        {
            'thingTypeName': 'string',
            'thingTypeArn': 'string',
            'thingTypeProperties': {
                'thingTypeDescription': 'string',
                'searchableAttributes': [
                    'string',
                ]
            },
            'thingTypeMetadata': {
                'deprecated': True|False,
                'deprecationDate': datetime(2015, 1, 1),
                'creationDate': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    The output for the ListThingTypes operation.

    • thingTypes (list) –

      The thing types.

      • (dict) –

        The definition of the thing type, including thing type name and description.

        • thingTypeName (string) –

          The name of the thing type.

        • thingTypeArn (string) –

          The thing type ARN.

        • thingTypeProperties (dict) –

          The ThingTypeProperties for the thing type.

          • thingTypeDescription (string) –

            The description of the thing type.

          • searchableAttributes (list) –

            A list of searchable thing attribute names.

            • (string) –

        • thingTypeMetadata (dict) –

          The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

          • deprecated (boolean) –

            Whether the thing type is deprecated. If true, no new things could be associated with this type.

          • deprecationDate (datetime) –

            The date and time when the thing type was deprecated.

          • creationDate (datetime) –

            The date and time when the thing type was created.

    • NextToken (string) –

      A token to resume pagination.