:doc:`IoT <../../iot>` / Paginator / ListThingTypes

**************
ListThingTypes
**************



.. py:class:: IoT.Paginator.ListThingTypes

  ::

    
    paginator = client.get_paginator('list_thing_types')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_thing_types`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListThingTypes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          thingTypeName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type thingTypeName: string
    :param thingTypeName: 

      The name of the thing type.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'thingTypes': [
                {
                    'thingTypeName': 'string',
                    'thingTypeArn': 'string',
                    'thingTypeProperties': {
                        'thingTypeDescription': 'string',
                        'searchableAttributes': [
                            'string',
                        ],
                        'mqtt5Configuration': {
                            'propagatingAttributes': [
                                {
                                    'userPropertyKey': 'string',
                                    'thingAttribute': 'string',
                                    'connectionAttribute': '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) --* 
            
              

              - **mqtt5Configuration** *(dict) --* 

                The configuration to add user-defined properties to enrich MQTT 5 messages.

                
                

                - **propagatingAttributes** *(list) --* 

                  An object that represents the propagating thing attributes and the connection attributes.

                  
                  

                  - *(dict) --* 

                    An object that represents the connection attribute, thing attribute, and the user property key.

                    
                    

                    - **userPropertyKey** *(string) --* 

                      The key of the user property key-value pair.

                      
                    

                    - **thingAttribute** *(string) --* 

                      The user-defined thing attribute that is propagating for MQTT 5 message enrichment.

                      
                    

                    - **connectionAttribute** *(string) --* 

                      The attribute associated with the connection between a device and Amazon Web Services IoT Core.

                      
                
              
            
          
            

            - **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.

          
    