IoT / Client / list_dimensions

list_dimensions

IoT.Client.list_dimensions(**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.

List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions action.

See also: AWS API Documentation

Request Syntax

response = client.list_dimensions(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) – The maximum number of results to retrieve at one time.

Return type:

dict

Returns:

Response Syntax

{
    'dimensionNames': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • dimensionNames (list) –

      A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

      • (string) –

    • nextToken (string) –

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

Exceptions