Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

describe-thing-type

Description

Gets information about the specified thing type.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-thing-type
--thing-type-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-type-name (string)

The name of the thing type.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about a thing type

The following describe-thing-type example display information about the specified thing type defined in your AWS account.

aws iot describe-thing-type \
    --thing-type-name "LightBulb"

Output:

{
    "thingTypeName": "LightBulb",
    "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190",
    "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
    "thingTypeProperties": {
        "thingTypeDescription": "light bulb type",
        "searchableAttributes": [
            "model",
            "wattage"
        ]
    },
    "thingTypeMetadata": {
        "deprecated": false,
        "creationDate": 1559772562.498
    }
}

For more information, see Thing Types in the AWS IoT Developers Guide.

Output

thingTypeName -> (string)

The name of the thing type.

thingTypeId -> (string)

The thing type ID.

thingTypeArn -> (string)

The thing type ARN.

thingTypeProperties -> (structure)

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 -> (structure)

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 -> (timestamp)

The date and time when the thing type was deprecated.

creationDate -> (timestamp)

The date and time when the thing type was created.