AWS IoT 1-Click Projects examples using AWS CLI

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

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

各例には、完全なソースコードへのリンクが含まれており、そこからコードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

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

AWS CLI

AWS アカウントからプロジェクトを削除するには

次の delete-project の例では、指定されたプロジェクトを AWS アカウントから削除します。


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

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

詳細については、「AWS IoT 1-Click Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

次の例は、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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

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

AWS CLI

プロジェクトリソースにタグを追加するには

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


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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

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

AWS CLI

プレイスメントの "attributes" キー値ペアを更新するには

次の update-placement の例では、プレイスメントの "attributes" キー値ペアを更新します。


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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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 Developer Guide」の「Using AWS IoT 1-Click with the AWS CLI」を参照してください。

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

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

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

ドキュメントの表記規則

AWS IoT 1-Click デバイス

AWS IoT Analytics