[ aws . iot ]

update-dimension

Description

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-dimension
--name <value>
--string-values <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

--string-values (list)

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, “admin/#”).

(string)

Syntax:

"string" "string" ...

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To update a dimension

The following update-dimension example updates a dimension.

aws iot update-dimension \
    --name TopicFilterForAuthMessages \
    --string-values device/${iot:ClientId}/auth

Output:

{
    "name": "TopicFilterForAuthMessages",
    "lastModifiedDate": 1585866222.317,
    "stringValues": [
        "device/${iot:ClientId}/auth"
    ],
    "creationDate": 1585854500.474,
    "type": "TOPIC_FILTER",
    "arn": "arn:aws:iot:us-west-2:1234564789012:dimension/TopicFilterForAuthMessages"
}

For more information, see Scoping metrics in security profiles using dimensions in the AWS IoT Core Developer Guide.

Output

name -> (string)

A unique identifier for the dimension.

arn -> (string)

The Amazon Resource Name (ARN)of the created 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 -> (timestamp)

The date and time, in milliseconds since epoch, when the dimension was initially created.

lastModifiedDate -> (timestamp)

The date and time, in milliseconds since epoch, when the dimension was most recently updated.