UpdateThing
Updates the data for a thing.
Requires permission to access the UpdateThing action.
Request Syntax
PATCH /things/thingName
HTTP/1.1
Content-type: application/json
{
"attributePayload": {
"attributes": {
"string
" : "string
"
},
"merge": boolean
},
"expectedVersion": number
,
"removeThingType": boolean
,
"thingTypeName": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- thingName
-
The name of the thing to update.
You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.
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.
- attributePayload
-
A list of thing attributes, a JSON string containing name-value pairs. For example:
{\"attributes\":{\"name1\":\"value2\"}}
This data is used to add new attributes or update existing attributes.
Type: AttributePayload object
Required: No
- expectedVersion
-
The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the
UpdateThing
request is rejected with aVersionConflictException
.Type: Long
Required: No
- removeThingType
-
Remove a thing type association. If true, the association is removed.
Type: Boolean
Required: No
- thingTypeName
-
The name of the thing type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
- VersionConflictException
-
An exception thrown when the version of an entity specified with the
expectedVersion
parameter does not match the latest version in the system.HTTP Status Code: 409
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: