Menu
AWS IoT
Developer Guide

DescribeThingType

Gets information about the specified thing type.

Request syntax:

GET /thing-types/thingTypeName

URI Request Parameters:

Name

Type

Req?

Description

thingTypeName

ThingTypeName

yes

The name of the thing type.

Response syntax:

Content-type: application/json { "thingTypeName": "string", "thingTypeId": "string", "thingTypeArn": "string", "thingTypeProperties": { "thingTypeDescription": "string", "searchableAttributes": [ "string" ] }, "thingTypeMetadata": { "deprecated": "boolean", "deprecationDate": "timestamp", "creationDate": "timestamp" } }

Response Body Parameters:

Name

Type

Req?

Description

thingTypeName

ThingTypeName

no

The name of the thing type.

thingTypeId

ThingTypeId

no

The thing type ID.

thingTypeArn

ThingTypeArn

no

The thing type ARN.

thingTypeProperties

ThingTypeProperties

no

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

thingTypeMetadata

ThingTypeMetadata

no

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.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

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

cli-input-json format:

{ "thingTypeName": "string" }

cli-input-json fields:

Name

Type

Description

thingTypeName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The name of the thing type.

Output:

{ "thingTypeName": "string", "thingTypeId": "string", "thingTypeArn": "string", "thingTypeProperties": { "thingTypeDescription": "string", "searchableAttributes": [ "string" ] }, "thingTypeMetadata": { "deprecated": "boolean", "deprecationDate": "timestamp", "creationDate": "timestamp" } }

cli output fields:

Name

Type

Description

thingTypeName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The name of the thing type.

thingTypeId

string

The thing type ID.

thingTypeArn

string

The thing type ARN.

thingTypeProperties

ThingTypeProperties

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

thingTypeDescription

string

length max:2028

pattern: [\\p{Graph} ]*

The description of the thing type.

searchableAttributes

list

member: AttributeName

java class: java.util.List

A list of searchable thing attribute names.

AttributeName

string

length max:128

pattern: [a-zA-Z0-9_.,@/:#-]+

thingTypeMetadata

ThingTypeMetadata

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.

On this page: