describe_dimension

IoT.Client.describe_dimension(**kwargs)

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

Requires permission to access the DescribeDimension action.

See also: AWS API Documentation

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.

Exceptions

• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ResourceNotFoundException
• IoT.Client.exceptions.ThrottlingException