Menu
AWS IoT
API Reference (API Version 2015-05-28)

DescribeThingType

Gets information about the specified thing type.

Request Syntax

GET /thing-types/thingTypeName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

thingTypeName

The name of the thing type.

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: ThingTypeMetadata object

thingTypeName

The name of the thing type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

thingTypeProperties

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

Type: ThingTypeProperties object

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: