Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 re-create it).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-dimension
--name <value>
--string-values <value>
[--cli-input-json <value>]
[--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Output

name -> (string)

A unique identifier for the dimension.

arn -> (string)

The ARN (Amazon resource name) 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.