Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

describe-thing

Description

Gets information about the specified thing.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-thing
--thing-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-name (string)

The name of the thing.

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

defaultClientId -> (string)

The default client ID.

thingName -> (string)

The name of the thing.

thingId -> (string)

The ID of the thing to describe.

thingArn -> (string)

The ARN of the thing to describe.

thingTypeName -> (string)

The thing type name.

attributes -> (map)

The thing attributes.

key -> (string)

value -> (string)

version -> (long)

The current version of the thing record in the registry.

Note

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.