[ aws . iot-data ]

get-thing-shadow

Description

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

For more information, see GetThingShadow in the IoT Developer Guide.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Note

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. The default endpoints (intended for testing purposes only) can be found at https://docs.aws.amazon.com/general/latest/gr/iot-core.html#iot-core-data-plane-endpoints

Synopsis

  get-thing-shadow
--thing-name <value>
[--shadow-name <value>]
<outfile>

Options

--thing-name (string)

The name of the thing.

--shadow-name (string)

The name of the shadow.

outfile (string) Filename where the content will be saved

See ‘aws help’ for descriptions of global parameters.

Examples

To get a thing shadow document

The following get-thing-shadow example gets the thing shadow document for the specified IoT thing.

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.