Creates a new thing type. If this call is made multiple times using
the same thing type name and configuration, the call will succeed. If this call is made with
the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.
Requires permission to access the CreateThingType action.
Request Syntax
POST /thing-types/thingTypeName HTTP/1.1
Content-type: application/json
{
"tags": [
{
"Key": "string",
"Value": "string"
}
],
"thingTypeProperties": {
"mqtt5Configuration": {
"propagatingAttributes": [
{
"connectionAttribute": "string",
"thingAttribute": "string",
"userPropertyKey": "string"
}
]
},
"searchableAttributes": [ "string" ],
"thingTypeDescription": "string"
}
}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 accepts the following data in JSON format.
-
Metadata which can be used to manage the thing type.
Type: Array of Tag objects
Required: No
- thingTypeProperties
-
The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.
Type: ThingTypeProperties object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"thingTypeArn": "string",
"thingTypeId": "string",
"thingTypeName": "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 Amazon Resource Name (ARN) of the thing type.
Type: String
- thingTypeId
-
The thing type ID.
Type: String
- thingTypeName
-
The name of the thing type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The resource already exists.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
