/thing-types/{thingTypeName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/thing-types/'

Response Example

200 - Example 1

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

Request

Path Params

thingTypeName

string

required

The name of the thing type.

Responses

🟢200Success

application/json

Body

The output for the DescribeThingType operation.

thingTypeName

string

optional

The name of the thing type.

>= 1 characters<= 128 characters

Match pattern:

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

thingTypeId

string

optional

The thing type ID.

thingTypeArn

string

optional

The thing type ARN.

thingTypeProperties

object

optional

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

thingTypeDescription

string

optional

The description of the thing type.

<= 2028 characters

Match pattern:

[\p{Graph}\x20]*

searchableAttributes

array[string]

optional

A list of searchable thing attribute names.

thingTypeMetadata

object

optional

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

optional

Whether the thing type is deprecated. If true, no new things could be associated with this type.

deprecationDate

string <date-time>

optional

The date and time when the thing type was deprecated.

creationDate

string <date-time>

optional

The date and time when the thing type was created.

🟠480ResourceNotFoundException

🟠481InvalidRequestException

🟠482ThrottlingException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException

Modified at 2022-09-10 23:12:15

/thing-types/{thingTypeName}

/rules/{ruleName}