/things/{thingName}

The AWS IoT Wireless multi-region endpoint

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

PATCH

/things/{thingName}

Updates the data for a thing.

Requires permission to access the UpdateThing action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/things/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thingTypeName": "string",
    "attributePayload": {
        "attributes": {
            "property1": "string",
            "property2": "string"
        },
        "merge": true
    },
    "expectedVersion": 0,
    "removeThingType": true
}'

Response Example

200 - Example 1

{}

Request

Path Params

thingName

string

required

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.

Body Params application/json

thingTypeName

string

optional

The name of the thing type.

>= 1 characters<= 128 characters

Match pattern:

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

attributePayload

object

optional

The attribute payload.

attributes

object

optional

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

merge

boolean

optional

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

expectedVersion

integer

optional

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 a VersionConflictException.

removeThingType

boolean

optional

Remove a thing type association. If true, the association is removed.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InvalidRequestException

🟠481VersionConflictException

🟠482ThrottlingException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException

🟠486ResourceNotFoundException

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

/things/{thingName}

/thing-groups/{thingGroupName}