AWS IoT 1-Click を使用したデバイスの例 AWS CLI

次のコード例は、を AWS IoT 1-Click デバイス AWS Command Line Interface で使用することでアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

アクション

次のコード例は、claim-devices-by-claim-code を使用する方法を示しています。

AWS CLI

クレームコードを使用して 1 つ以上の 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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のClaimDevicesByClaimCode」を参照してください。

次の例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のDescribeDevice」を参照してください。

次のコード例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のFinalizeDeviceClaim」を参照してください。

次の例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のGetDeviceMethods」を参照してください。

次のコード例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のInitiateDeviceClaim」を参照してください。

次のコード例は、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 デベロッパーガイド」の AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のInvokeDeviceMethod」を参照してください。

次の例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のListDeviceEvents」を参照してください。

次の例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のListDevices」を参照してください。

次のコード例は、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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のListTagsForResource」を参照してください。

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

デバイス AWS リソースにタグを追加するには

次のtag-resource例では、指定されたリソースに 2 つのタグを追加します。


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 デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のTagResource」を参照してください。

次のコード例は、unclaim-device を使用する方法を示しています。

AWS CLI

AWS アカウントからデバイスを請求 (登録解除) するには

次のunclaim-device例では、指定されたデバイスを AWS アカウントから要求解除 (登録解除) します。


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

出力:


{
    "State": "UNCLAIMED"
}

詳細については、AWS IoT 1-Click デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のUnclaimDevice」を参照してください。

次のコード例は、untag-resource を使用する方法を示しています。

AWS CLI

デバイス AWS リソースからタグを削除するには

次の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"

このコマンドでは何も出力されません。

詳細については、AWS IoT 1-Click デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のUntagResource」を参照してください。

次の例は、update-device-state を使用する方法を説明しています。

AWS CLI

デバイスの「有効」状態を更新するには

次に、指定されたデバイスの状態を update-device-stateに設定しますenabled。


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

このコマンドでは何も出力されません。

詳細については、AWS IoT 1-Click デベロッパーガイドの AWS CLI での IoT 1-Click の使用」を参照してください。 AWS IoT 1-Click

API の詳細については、AWS CLI 「コマンドリファレンス」のUpdateDeviceState」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS IoT

AWS IoT 1-Click プロジェクト