Amazon IoT 1-Click 使用的设备示例 Amazon CLI - Amazon Command Line Interface
操作
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Amazon IoT 1-Click 使用的设备示例 Amazon CLI

以下代码示例向您展示了如何使用 with Devices 来执行操作和实现常见场 Amazon IoT 1-Click 景。 Amazon Command Line Interface

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

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

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

主题

操作

以下代码示例演示如何使用 claim-devices-by-claim-code。

Amazon CLI

使用优惠码申领一台或多 Amazon 台 IoT 1-Click 设备

以下claim-devices-by-claim-code示例使用优惠码（而不是设备 ID）声明指定的 Amazon IoT 1-Click 设备。

aws iot1click-devices claim-devices-by-claim-code \
    --claim-code C-123EXAMPLE

输出：

{
   "Total": 9
   "ClaimCode": "C-123EXAMPLE"
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

以下代码示例演示如何使用 describe-device。

Amazon CLI

描述设备

以下describe-device示例描述了指定的设备。

aws iot1click-devices describe-device \
    --device-id G030PM0123456789

输出：

{
    "DeviceDescription": {
        "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789",
        "Attributes": {
            "projectRegion": "us-west-2",
            "projectName": "AnytownDumpsters",
            "placementName": "customer217",
            "deviceTemplateName": "empty-dumpster-request"
        },
        "DeviceId": "G030PM0123456789",
        "Enabled": false,
        "RemainingLife": 99.9,
        "Type": "button",
        "Tags": {}
    }
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeDevice中的。

以下代码示例演示如何使用 finalize-device-claim。

Amazon CLI

使用设备 ID 完成 I Amazon oT 1-Click 设备的索赔申请

以下finalize-device-claim示例使用设备 ID（而不是折扣码）最终确定了针对指定 Io Amazon T 1-Click 设备的索赔请求。

aws iot1click-devices finalize-device-claim \
    --device-id G030PM0123456789

输出：

{
    "State": "CLAIMED"
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

以下代码示例演示如何使用 get-device-methods。

Amazon CLI

列出设备的可用方法

以下get-device-methods示例列出了设备的可用方法。

aws iot1click-devices get-device-methods \
    --device-id G030PM0123456789

输出：

{
    "DeviceMethods": [
        {
            "MethodName": "getDeviceHealthParameters"
        },
        {
            "MethodName": "setDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "getDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "setOnClickCallback"
        },
        {
            "MethodName": "getOnClickCallback"
        }
    ]
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetDeviceMethods中的。

以下代码示例演示如何使用 initiate-device-claim。

Amazon CLI

使用设备 ID 为 Amazon IoT 1-Click 设备发起索赔请求

以下initiate-device-claim示例使用设备 ID（而不是折扣码）为指定的 Io Amazon T 1-Click 设备发起索赔请求。

aws iot1click-devices initiate-device-claim \
    --device-id G030PM0123456789

输出：

{
    "State": "CLAIM_INITIATED"
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

以下代码示例演示如何使用 invoke-device-method。

Amazon CLI

在设备上调用设备方法

以下invoke-device-method示例在设备上调用指定的方法。

aws iot1click-devices invoke-device-method \
    --cli-input-json file://invoke-device-method.json

invoke-device-method.json 的内容：

{
    "DeviceId": "G030PM0123456789",
    "DeviceMethod": {
        "DeviceType": "device",
        "MethodName": "getDeviceHealthParameters"
    }
}

输出：

{
    "DeviceMethodResponse": "{\"remainingLife\": 99.8}"
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考InvokeDeviceMethod中的。

以下代码示例演示如何使用 list-device-events。

Amazon CLI

列出指定时间范围内的设备事件

以下list-device-events示例列出了指定设备在指定时间范围内的事件。

aws iot1click-devices list-device-events \
    --device-id G030PM0123456789 \
    --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z

输出：

{
    "Events": [
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}"
        },
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}"
        }
    ]
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListDeviceEvents中的。

以下代码示例演示如何使用 list-devices。

Amazon CLI

列出指定类型的设备

以下list-devices示例列出了指定类型的设备。

aws iot1click-devices list-devices \
    --device-type button

此命令不生成任何输出。

输出：

{
    "Devices": [
        {
            "remainingLife": 99.9,
            "attributes": {
                "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
                "type": "button",
                "deviceId": "G030PM0123456789",
                "enabled": false
            }
        }
    ]
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListDevices中的。

以下代码示例演示如何使用 list-tags-for-resource。

Amazon CLI

列出设备的标签

以下list-tags-for-resource示例列出了指定设备的标签。

aws iot1click-devices list-tags-for-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789"

输出：

{
    "Tags": {
        "Driver Phone": "123-555-0199",
        "Driver": "Jorge Souza"
    }
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

以下代码示例演示如何使用 tag-resource。

Amazon CLI

向设备 Amazon 资源添加标签

以下tag-resource示例向指定资源添加了两个标签。

aws iot1click-devices tag-resource \
    --cli-input-json file://devices-tag-resource.json

devices-tag-resource.json 的内容：

{
    "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
    "Tags": {
        "Driver": "Jorge Souza",
        "Driver Phone": "123-555-0199"
    }
}

此命令不生成任何输出。

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考TagResource中的。

以下代码示例演示如何使用 unclaim-device。

Amazon CLI

从您的账户中取消认领（注销）设备 Amazon

以下unclaim-device示例从您的 Amazon 账户中取消对指定设备的声明（注销）。

aws iot1click-devices unclaim-device \
    --device-id G030PM0123456789

输出：

{
    "State": "UNCLAIMED"
}

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UnclaimDevice中的。

以下代码示例演示如何使用 untag-resource。

Amazon CLI

从设备 Amazon 资源中移除标签

以下untag-resource示例Driver从指定的设备资源中删除名称为Driver Phone和的标签。

aws iot1click-devices untag-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \
    --tag-keys "Driver Phone" "Driver"

此命令不生成任何输出。

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UntagResource中的。

以下代码示例演示如何使用 update-device-state。

Amazon CLI

更新设备的 “已启用” 状态

以下内容update-device-state将指定设备的状态设置为enabled。

aws iot1click-devices update-device-state \
    --device-id G030PM0123456789 \
    --enabled

此命令不生成任何输出。

有关更多信息，请参阅《Amazon IoT 1-Click 开发者指南》中的将 Io T 1-Clic Amazon k 与 Amazon CLI 配合使用。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateDeviceState中的。