Table Of Contents

Feedback

User Guide

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

[ aws . iot-data ]

update-thing-shadow

Description

Updates the thing shadow for the specified thing.

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Note

The default endpoint data.iot.[region].amazonaws.com is intended for testing purposes only. For production code it is strongly recommended to use the custom endpoint for your account (retrievable via the iot describe-endpoint command) to ensure best availability and reachability of the service.

Synopsis

  update-thing-shadow
--thing-name <value>
--payload <value>
outfile <value>

Options

--thing-name (string)

The name of the thing.

--payload (blob)

The state information, in JSON format.

outfile (string) Filename where the content will be saved

See 'aws help' for descriptions of global parameters.

Examples

To get the current state of a device shadow

The following get-thing-shadow example gets the current state of the device shadow for the thing named MyRPi and saves it to the file output.txt.

aws iot-data get-thing-shadow \
    --thing-name MyRPi \
    "output.txt"

The command produces no output on the display, but the following shows the contents of output.txt:

{"state":{"reported":{"moisture":"low"}},"metadata":{"reported":{"moisture":{"timestamp":1560269319}}},"version":1,"timestamp":1560269405}

For more information, see Device Shadow Service Data Flow in the AWS IoT Developers Guide.

Output

payload -> (blob)

The state information, in JSON format.