AWS IoT 1-Click 使用的裝置範例 AWS CLI

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

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

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

主題

動作

動作

下列程式碼範例示範如何使用 claim-devices-by-claim-code。

AWS CLI

使用宣告代碼來宣告一或多個 AWS IoT 1-Click裝置

下列claim-devices-by-claim-code範例使用宣告代碼（而非裝置 ID）宣告指定的 AWS IoT 1-Click裝置。


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

輸出：


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

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

如需API詳細資訊，請參閱命令參考 ClaimDevicesByClaimCode中的。 AWS CLI

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

AWS 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": {}
    }
}

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

如需API詳細資訊，請參閱命令參考 DescribeDevice中的。 AWS CLI

下列程式碼範例示範如何使用 finalize-device-claim。

AWS CLI

使用裝置 ID 完成 AWS IoT 1-Click裝置的宣告請求

下列finalize-device-claim範例使用裝置 ID （而非宣告代碼）完成指定 AWS IoT 1-Click裝置宣告請求。


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

輸出：


{
    "State": "CLAIMED"
}

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

如需API詳細資訊，請參閱命令參考 FinalizeDeviceClaim中的。 AWS CLI

下列程式碼範例示範如何使用 get-device-methods。

AWS CLI

列出裝置的可用方法

下列get-device-methods範例列出裝置的可用方法。


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

輸出：


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

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

如需API詳細資訊，請參閱命令參考 GetDeviceMethods中的。 AWS CLI

下列程式碼範例示範如何使用 initiate-device-claim。

AWS CLI

使用裝置 ID 啟動 AWS IoT 1-Click裝置的宣告請求

下列initiate-device-claim範例使用裝置 ID （而非宣告代碼）啟動指定 AWS IoT 1-Click裝置宣告請求。


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

輸出：


{
    "State": "CLAIM_INITIATED"
}

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

如需API詳細資訊，請參閱命令參考 InitiateDeviceClaim中的。 AWS CLI

下列程式碼範例示範如何使用 invoke-device-method。

AWS 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}"
}

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

如需API詳細資訊，請參閱命令參考 InvokeDeviceMethod中的。 AWS CLI

下列程式碼範例示範如何使用 list-device-events。

AWS 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}"
        }
    ]
}

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

如需API詳細資訊，請參閱命令參考 ListDeviceEvents中的。 AWS CLI

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

AWS 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
            }
        }
    ]
}

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

如需API詳細資訊，請參閱命令參考 ListDevices中的。 AWS CLI

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS 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"
    }
}

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

如需API詳細資訊，請參閱命令參考 ListTagsForResource中的。 AWS CLI

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

將標籤新增至裝置 AWS 資源

下列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"
    }
}

此命令不會產生輸出。

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

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

下列程式碼範例示範如何使用 unclaim-device。

AWS CLI

從 AWS 您的帳戶取消領取（取消註冊）裝置

下列unclaim-device範例會從 AWS 您的帳戶取消宣告（取消註冊）指定的裝置。


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

輸出：


{
    "State": "UNCLAIMED"
}

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

如需API詳細資訊，請參閱命令參考 UnclaimDevice中的。 AWS CLI

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

從裝置 AWS 資源中移除標籤

下列untag-resource範例會從指定的裝置資源中移除具有 Driver Phone和名稱Driver的標籤。


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

此命令不會產生輸出。

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

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

下列程式碼範例示範如何使用 update-device-state。

AWS CLI

更新裝置的 ``enabled`` 狀態

下列會將指定裝置update-device-state的狀態設定為 enabled。


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

此命令不會產生輸出。

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

如需API詳細資訊，請參閱命令參考 UpdateDeviceState中的。 AWS CLI

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

AWS IoT

AWS IoT 1-Click 專案

AWS IoT 1-Click 使用 的裝置範例 AWS CLI

主題

動作

AWS IoT 1-Click 使用的裝置範例 AWS CLI