list_dimensions

IoT.Client.list_dimensions(**kwargs)

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

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