View a markdown version of this page

AWS IoT data examples using AWS CLI - AWS Command Line Interface
Actions

AWS IoT data examples using AWS CLI

The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS IoT data.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.

Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use delete-thing-shadow.

AWS CLI

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 "output.txt" \
    --thing-name MyRPi

This command produces no output. The output.txt file 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.

The following code example shows how to use get-thing-shadow.

AWS CLI

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 output.txt \
    --thing-name MyRPi

Contents of output.txt:

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

This command produces no output.

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

The following code example shows how to use update-thing-shadow.

AWS CLI

To update a thing shadow

The following update-thing-shadow example modifies the current state of the device shadow for the specified thing and saves it to the file output.txt.

aws iot-data update-thing-shadow "output.txt" \
    --cli-binary-format raw-in-base64-out \
    --thing-name MyRPi \
    --payload '{"state":{"reported":{"moisture":"okay"}}}'

This command produces no output. The response payload is saved to output.txt.

Contents of output.txt:

{
    "state": {
        "reported": {
            "moisture": "okay"
        }
    },
    "metadata": {
        "reported": {
            "moisture": {
                "timestamp": 1560270036
            }
        }
    },
    "version": 2,
    "timestamp": 1560270036
}

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