[ aws . iot ]

list-dimensions

Description

List the set of dimensions that are defined for your AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-dimensions
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--next-token (string)

The token for the next set of results.

--max-results (integer)

The maximum number of results to retrieve at one time.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list the dimensions for your AWS account

The following list-dimensions example lists all AWS IoT Device Defender dimensions that are defined in your AWS account.

aws iot list-dimensions

Output:

{
    "dimensionNames": [
        "TopicFilterForAuthMessages",
        "TopicFilterForActivityMessages"
    ]
}

For more information, see Detect Commands in the AWS IoT Developer Guide.

Output

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.