/dimensions/{name}

The AWS IoT Wireless multi-region endpoint

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

GET

/dimensions/{name}

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/dimensions/'

Response Example

200 - Example 1

{
    "name": "string",
    "arn": "string",
    "type": "TOPIC_FILTER",
    "stringValues": [],
    "creationDate": "string",
    "lastModifiedDate": "string"
}

Request

Path Params

name

string

required

The unique identifier for the dimension.

Responses

🟢200Success

application/json

Body

name

string

optional

The unique identifier for the dimension.

>= 1 characters<= 128 characters

Match pattern:

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

arn

string

optional

The Amazon Resource Name (ARN) for the 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 the dimension was created.

lastModifiedDate

string <date-time>

optional

The date the dimension was last modified.

🟠480InternalFailureException

🟠481InvalidRequestException

🟠482ResourceNotFoundException

🟠483ThrottlingException

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

/partner-accounts/{PartnerAccountId}

/log-levels