IoT / Client / describe_dimension

describe_dimension¶

IoT.Client.describe_dimension(**kwargs)¶

Note

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.

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

Requires permission to access the DescribeDimension action.

Request Syntax

response = client.describe_dimension(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The unique identifier for the dimension.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'type': 'TOPIC_FILTER',
    'stringValues': [
        'string',
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- name (string) –
  
  The unique identifier for the dimension.
- arn (string) –
  
  The Amazon Resource Name (ARN) for the dimension.
- type (string) –
  
  The type of the dimension.
- stringValues (list) –
  
  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.
  - (string) –
- creationDate (datetime) –
  
  The date the dimension was created.
- lastModifiedDate (datetime) –
  
  The date the dimension was last modified.