[ aws . iot-data ]

delete-thing-shadow

Description

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

For more information, see DeleteThingShadow in the 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

  delete-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 delete a device’s shadow document

The following delete-thing-shadow example deletes the entire shadow document for the device named MyRPi.

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

The command produces no output on the display, but output.txt contains information that confirms the version and timestamp of the shadow document that you deleted.

{"version":2,"timestamp":1560270384}

For more information, see Using Shadows in the AWS IoT Developers Guide.

Output

payload -> (blob)

The state information, in JSON format.