Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeThingType

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

Request Syntax


GET /thing-types/thingTypeName HTTP/1.1

URI Request Parameters

The request uses 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:_-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "thingTypeArn": "string",
   "thingTypeId": "string",
   "thingTypeMetadata": { 
      "creationDate": number,
      "deprecated": boolean,
      "deprecationDate": number
   },
   "thingTypeName": "string",
   "thingTypeProperties": { 
      "mqtt5Configuration": { 
         "propagatingAttributes": [ 
            { 
               "connectionAttribute": "string",
               "thingAttribute": "string",
               "userPropertyKey": "string"
            }
         ]
      },
      "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.

thingTypeArn

The thing type ARN.

Type: String

thingTypeId

The thing type ID.

Type: String

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, a list of searchable thing attribute names, and MQTT5 configuration.

Type: ThingTypeProperties object

Errors

InternalFailureException

An unexpected error has occurred.

message: The message for the exception.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

message: The message for the exception.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

message: The message for the exception.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

message: The message for the exception.

HTTP Status Code: 401