AWS IoT 1-Click 使用项目示例 AWS CLI - AWS Command Line Interface

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

AWS IoT 1-Click 使用项目示例 AWS CLI

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

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

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

主题

操作

以下代码示例显示了如何使用associate-device-with-placement

AWS CLI

将 I AWS oT 1-Click 设备与现有展示位置关联

以下associate-device-with-placement示例将指定的 AWS IoT 1-Click 设备与现有展示位置相关联。

aws iot1click-projects associate-device-with-placement \ --project-name AnytownDumpsters \ --placement-name customer217 \ --device-template-name empty-dumpster-request \ --device-id G030PM0123456789

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

以下代码示例显示了如何使用create-placement

AWS CLI

为项目创建 I AWS oT 1-Click 展示位置

以下create-placement示例为指定项目创建 AWS IoT 1-Click 展示位置。

aws iot1click-projects create-placement \ --project-name AnytownDumpsters \ --placement-name customer217 \ --attributes "{"location": "123 Any Street Anytown, USA 10001", "phone": "123-456-7890"}"

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考CreatePlacement中的。

以下代码示例显示了如何使用create-project

AWS CLI

为零个或多个展示位置创建 AWS IoT 1-Click 项目

以下create-project示例为展示位置创建一个 AWS IoT 1-Click 项目。

aws iot1click-projects 创建项目 — file: //create-project.json cli-input-json

create-project.json 的内容:

{ "projectName": "AnytownDumpsters", "description": "All dumpsters in the Anytown region.", "placementTemplate": { "defaultAttributes": { "City" : "Anytown" }, "deviceTemplates": { "empty-dumpster-request" : { "deviceType": "button" } } } }

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考CreateProject中的。

以下代码示例显示了如何使用delete-placement

AWS CLI

从项目中删除展示位置

以下delete-placement示例从项目中删除指定的展示位置。

aws iot1click-projects delete-placement \ --project-name AnytownDumpsters \ --placement-name customer217

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考DeletePlacement中的。

以下代码示例显示了如何使用delete-project

AWS CLI

从您的 AWS 账户中删除项目

以下delete-project示例从您的 AWS 账户中删除指定的项目。

aws iot1click-projects delete-project \ --project-name AnytownDumpsters

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考DeleteProject中的。

以下代码示例显示了如何使用describe-placement

AWS CLI

描述项目的展示位置

以下describe-placement示例描述了指定项目的展示位置。

aws iot1click-projects describe-placement \ --project-name AnytownDumpsters \ --placement-name customer217

输出:

{ "placement": { "projectName": "AnytownDumpsters", "placementName": "customer217", "attributes": { "phone": "123-555-0110", "location": "123 Any Street Anytown, USA 10001" }, "createdDate": 1563488454, "updatedDate": 1563488454 } }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

以下代码示例显示了如何使用describe-project

AWS CLI

描述 I AWS oT 1-Click 项目

以下describe-project示例描述了指定的 AWS IoT 1-Click 项目。

aws iot1click-projects describe-project \ --project-name AnytownDumpsters

输出:

{ "project": { "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", "projectName": "AnytownDumpsters", "description": "All dumpsters in the Anytown region.", "createdDate": 1563483100, "updatedDate": 1563483100, "placementTemplate": { "defaultAttributes": { "City": "Anytown" }, "deviceTemplates": { "empty-dumpster-request": { "deviceType": "button", "callbackOverrides": {} } } }, "tags": {} } }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考DescribeProject中的。

以下代码示例显示了如何使用disassociate-device-from-placement

AWS CLI

取消设备与放置位置的关联

以下disassociate-device-from-placement示例取消指定设备与放置位置的关联。

aws iot1click-projects disassociate-device-from-placement \ --project-name AnytownDumpsters \ --placement-name customer217 \ --device-template-name empty-dumpster-request

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

以下代码示例显示了如何使用get-devices-in-placement

AWS CLI

列出项目中某个位置中的所有设备

以下get-devices-in-placement示例列出了指定项目中包含的位于指定位置的所有设备。

aws iot1click-projects get-devices-in-placement \ --project-name AnytownDumpsters \ --placement-name customer217

输出:

{ "devices": { "empty-dumpster-request": "G030PM0123456789" } }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

以下代码示例显示了如何使用list-placements

AWS CLI

列出项目的所有 AWS 物联网 1-Click 展示位置

以下list-placements示例列出了指定项目的所有 AWS IoT 1-Click 展示位置。

aws iot1click-projects list-placements \ --project-name AnytownDumpsters

输出:

{ "placements": [ { "projectName": "AnytownDumpsters", "placementName": "customer217", "createdDate": 1563488454, "updatedDate": 1563488454 } ] }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考ListPlacements中的。

以下代码示例显示了如何使用list-projects

AWS CLI

列出所有 AWS IoT 1-Click 项目

以下list-projects示例列出了您账户中的所有 AWS IoT 1-Click 项目。

aws iot1click-projects list-projects

输出:

{ "projects": [ { "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", "projectName": "AnytownDumpsters", "createdDate": 1563483100, "updatedDate": 1563483100, "tags": {} } ] }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考ListProjects中的。

以下代码示例显示了如何使用list-tags-for-resource

AWS CLI

列出项目资源的标签

以下list-tags-for-resource示例列出了指定项目资源的标签。

aws iot1click-projects list-tags-for-resource \ --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters"

输出:

{ "tags": { "Manager": "Li Juan", "Account": "45215" } }

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

以下代码示例显示了如何使用tag-resource

AWS CLI

为项目资源添加标签

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

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

devices-tag-resource.json 的内容:

{ "resourceArn": "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters", "tags": { "Account": "45215", "Manager": "Li Juan" } }

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

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

以下代码示例显示了如何使用untag-resource

AWS CLI

从项目资源中移除标签

以下untag-resource示例Manager从指定项目中删除带有密钥名称的标签。

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

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

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

以下代码示例显示了如何使用update-placement

AWS CLI

更新展示位置的 “属性” 键值对

以下update-placement示例更新展示位置的 “属性” 键值对。

aws iot1click-projects update-placement \ --cli-input-json file://update-placement.json

update-placement.json 的内容:

{ "projectName": "AnytownDumpsters", "placementName": "customer217", "attributes": { "phone": "123-456-7890", "location": "123 Any Street Anytown, USA 10001" } }

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考UpdatePlacement中的。

以下代码示例显示了如何使用update-project

AWS CLI

更新项目的设置

以下update-project示例更新了项目的描述。

aws iot1click-projects update-project \ --project-name AnytownDumpsters \ --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region."

此命令不生成任何输出。

有关更多信息,请参阅《AWS IoT 1-Click 开发者指南》 AWS CLI中的 “将 Io T 1-Click 与AWS ” 配合使用

  • 有关API详细信息,请参阅AWS CLI 命令参考UpdateProject中的。