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

ListThingTypes

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

Request Syntax


GET /thing-types?maxResults=maxResults&nextToken=nextToken&thingTypeName=thingTypeName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in this operation.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

{
   "nextToken": "string",
   "thingTypes": [ 
      { 
         "thingTypeArn": "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.

nextToken

The token for the next set of results. Will not be returned if operation has returned all results.

Type: String

thingTypes

The thing types.

Type: Array of ThingTypeDefinition objects

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401