/dimensions/{name} - AWS IoT Wireless

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/dimensions/' \ --header 'Content-Type: application/json' \ --data-raw '{ "stringValues": [ "string" ] }'

Request

Path Params

name

string

required

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Body Params application/json

stringValues

array[string]

required

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

>= 1 items<= 100 items

Examples

Responses

🟢200Success

application/json

Body

name

string

optional

A unique identifier for the dimension.

>= 1 characters<= 128 characters

Match pattern:

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

arn

string

optional

The Amazon Resource Name (ARN)of the created dimension.

type

enum<string>

optional

The type of the dimension.

Allowed value:

TOPIC_FILTER

stringValues

array[string]

optional

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

>= 1 items<= 100 items

creationDate

string <date-time>

optional

The date and time, in milliseconds since epoch, when the dimension was initially created.

lastModifiedDate

string <date-time>

optional

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

🟠480InternalFailureException

🟠481InvalidRequestException

🟠482ResourceNotFoundException

🟠483ThrottlingException