:doc:`IoT <../../iot>` / Client / describe_thing_type

*******************
describe_thing_type
*******************



.. py:method:: IoT.Client.describe_thing_type(**kwargs)

  

  Gets information about the specified thing type.

   

  Requires permission to access the `DescribeThingType <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

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


  **Request Syntax**
  ::

    response = client.describe_thing_type(
        thingTypeName='string'
    )
    
  :type thingTypeName: string
  :param thingTypeName: **[REQUIRED]** 

    The name of the thing type.

    

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

    
    ::

      {
          'thingTypeName': 'string',
          'thingTypeId': '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)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The output for the DescribeThingType operation.

      
      

      - **thingTypeName** *(string) --* 

        The name of the thing type.

        
      

      - **thingTypeId** *(string) --* 

        The thing type ID.

        
      

      - **thingTypeArn** *(string) --* 

        The thing type ARN.

        
      

      - **thingTypeProperties** *(dict) --* 

        The ThingTypeProperties contains information about the thing type including description, a list of searchable thing attribute names, and MQTT5 configuration.

        
        

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

          
    
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`IoT.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  