describe_thing_type

IoT.Client.describe_thing_type(**kwargs)

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_type(
    thingTypeName='string'
)

Parameters

thingTypeName (string) --

[REQUIRED]

The name of the thing type.

Return type

dict

Returns

Response Syntax

{
    'thingTypeName': 'string',
    'thingTypeId': 'string',
    'thingTypeArn': 'string',
    'thingTypeProperties': {
        'thingTypeDescription': 'string',
        'searchableAttributes': [
            '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, and a list of searchable thing attribute names.

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

Exceptions

• IoT.Client.exceptions.ResourceNotFoundException
• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.InternalFailureException