AWS IoT 1-Click 使用 的專案範例 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

AWS IoT 1-Click 使用 的專案範例 AWS CLI

下列程式碼範例示範如何透過 AWS Command Line Interface 搭配 AWS IoT 1-Click Projects 使用 來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會示範如何呼叫個別服務函數,但您可以在相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例示範如何使用 associate-device-with-placement

AWS CLI

將 AWS IoT 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

下列程式碼範例示範如何使用 create-placement

AWS CLI

為專案建立 AWS IoT 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 CreatePlacement中的 。 AWS CLI

下列程式碼範例示範如何使用 create-project

AWS CLI

若要為零或多個置放建立 AWS IoT 1-Click專案

下列create-project範例會為置放建立 AWS IoT 1-Click專案。

aws iot1click-projects create-project --cli-input-json file://create-project.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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 CreateProject中的 。 AWS CLI

下列程式碼範例示範如何使用 delete-placement

AWS CLI

從專案中刪除置放

下列delete-placement範例會從專案中刪除指定的置放。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 AWS IoT 1-Click 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 DeletePlacement中的 。 AWS CLI

下列程式碼範例示範如何使用 delete-project

AWS CLI

從 AWS 您的帳戶刪除專案

下列delete-project範例會從 AWS 您的帳戶刪除指定的專案。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 AWS IoT 1-Click 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 DeleteProject中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

下列程式碼範例示範如何使用 describe-project

AWS CLI

描述 AWS IoT 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 DescribeProject中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

下列程式碼範例示範如何使用 list-placements

AWS CLI

列出專案的所有 AWS IoT 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 ListPlacements中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 ListProjects中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 TagResource中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 UntagResource中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 UpdatePlacement中的 。 AWS CLI

下列程式碼範例示範如何使用 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 開發人員指南中的使用 IoT 1-Click 搭配 AWS CLI AWS IoT1-Click

  • 如需API詳細資訊,請參閱 命令參考 UpdateProject中的 。 AWS CLI