# 使用 AWS CLI 的 AWS IoT data示例
<a name="cli_iot-data-plane_code_examples"></a>

以下代码示例演示如何通过将 AWS Command Line Interface与 AWS IoT data 结合使用，来执行操作和实现常见场景。

*操作是大型程序的代码摘录*，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `delete-thing-shadow`
<a name="iot-data-plane_DeleteThingShadow_cli_topic"></a>

以下代码示例演示了如何使用 `delete-thing-shadow`。

**AWS CLI**  
**删除设备的影子文档**  
以下 `delete-thing-shadow` 示例删除名为 `MyRPi` 的设备的整个影子文档。  

```
aws iot-data delete-thing-shadow \
    --thing-name MyRPi \
    "output.txt"
```
该命令不会在显示屏上生成任何输出，但 `output.txt` 中包含确认您删除的影子文档的版本和时间戳的信息。  

```
{"version":2,"timestamp":1560270384}
```
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[使用影子](https://docs.aws.amazon.com/iot/latest/developerguide/using-device-shadows.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeleteThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/delete-thing-shadow.html)。

### `get-thing-shadow`
<a name="iot-data-plane_GetThingShadow_cli_topic"></a>

以下代码示例演示了如何使用 `get-thing-shadow`。

**AWS CLI**  
**获取事物影子文档**  
以下 `get-thing-shadow` 示例获取指定 IoT 事物的事物影子文档。  

```
aws iot-data get-thing-shadow \
    --thing-name MyRPi \
    output.txt
```
该命令不会在显示屏上生成任何输出，但以下显示了 `output.txt` 的内容：  

```
{
  "state":{
    "reported":{
    "moisture":"low"
    }
  },
  "metadata":{
    "reported":{
      "moisture":{
        "timestamp":1560269319
      }
    }
  },
  "version":1,"timestamp":1560269405
}
```
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[设备影子服务数据流](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/get-thing-shadow.html)。

### `update-thing-shadow`
<a name="iot-data-plane_UpdateThingShadow_cli_topic"></a>

以下代码示例演示了如何使用 `update-thing-shadow`。

**AWS CLI**  
**更新事物影子**  
以下 `update-thing-shadow` 示例修改了指定事物的设备影子的当前状态并将其保存到文件 `output.txt` 中。  

```
aws iot-data update-thing-shadow \
    --thing-name MyRPi \
    --payload "{"state":{"reported":{"moisture":"okay"}}}" \
    "output.txt"
```
该命令不会在显示屏上生成任何输出，但以下显示了 `output.txt` 的内容：  

```
{
    "state": {
        "reported": {
            "moisture": "okay"
        }
    },
    "metadata": {
        "reported": {
            "moisture": {
                "timestamp": 1560270036
            }
        }
    },
    "version": 2,
    "timestamp": 1560270036
}
```
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[设备影子服务数据流](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [UpdateThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/update-thing-shadow.html)。