を使用した Device Advisor の例 AWS CLI

次のコード例は、 Device Advisor AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

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

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

トピック

アクション

アクション

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

AWS CLI

例 1: IoT Device Advisor テストスイートを作成するには

次のcreate-suite-definition例では、指定されたスイート定義設定で AWS IoT にデバイスアドバイザーテストスイートを作成します。


aws iotdeviceadvisor create-suite-definition \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": false, \
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

出力:


{
    "suiteDefinitionId": "0jtsgio7yenu",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/0jtsgio7yenu",
    "suiteDefinitionName": "TestSuiteName",
    "createdAt": "2022-12-02T11:38:13.263000-05:00"
}

詳細については、「 IoT Core デベロッパーガイド」の「テストスイート定義AWS の作成 IoT」を参照してください。

例 2: IoT Device Advisor の最新の認定テストスイートを作成するには

次のcreate-suite-definition例では、指定されたスイート定義設定で AWS IoT の最新バージョンを持つデバイスアドバイザー認定テストスイートを作成します。


aws iotdeviceadvisor create-suite-definition \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": true, \
        "rootGroup": "", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

出力:


{
    "suiteDefinitionId": "txgsuolk2myj",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/txgsuolk2myj",
    "suiteDefinitionName": "TestSuiteName",
    "createdAt": "2022-12-02T11:38:13.263000-05:00"
}

詳細については、「 IoT Core デベロッパーガイド」の「テストスイート定義AWS の作成 IoT」を参照してください。

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

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

AWS CLI

IoT Device Advisor テストスイートを削除するには

次のdelete-suite-definition例では、指定されたスイート定義 ID を持つデバイスアドバイザーテストスイートを削除します。


aws iotdeviceadvisor delete-suite-definition \
    --suite-definition-id 0jtsgio7yenu

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

詳細については、AWS IoT APIリファレンスのDeleteSuiteDefinition「」を参照してください。

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

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

AWS CLI

例 1: IoT Device Advisor アカウントレベルのエンドポイントに関する情報を取得するには

次のget-endpoint例では、デバイスアドバイザーのアカウントレベルのテストエンドポイントに関する情報を取得します。


aws iotdeviceadvisor get-endpoint

出力:


{
    "endpoint": "t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com"
}

例 2: IoT Device Advisor デバイスレベルのエンドポイントに関する情報を取得するには

次のget-endpoint例では、指定された thing-arn または certificate-arn を持つデバイスアドバイザーのデバイスレベルのテストエンドポイントに関する情報を取得します。


aws iotdeviceadvisor get-endpoint \
    --thing-arn arn:aws:iot:us-east-1:123456789012:thing/MyIotThing

出力:


{
    "endpoint": "tdb7719be5t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com"
}

詳細については、AWS 「 IoT Core デベロッパーガイド」の「テストエンドポイントの取得」を参照してください。

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

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

AWS CLI

IoT Device Advisor テストスイートに関する情報を取得するには

次のget-suite-definition例では、指定されたスイート定義 ID を持つ Aevice アドバイザーテストスイートに関する情報を取得します。


aws iotdeviceadvisor get-suite-definition \
    --suite-definition-id qqcsmtyyjabl

出力:


{
    "suiteDefinitionId": "qqcsmtyyjabl",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/qqcsmtyyjabl",
    "suiteDefinitionVersion": "v1",
    "latestVersion": "v1",
    "suiteDefinitionConfiguration": {
        "suiteDefinitionName": "MQTT connection",
        "devices": [],
        "intendedForQualification": false,
        "isLongDurationTest": false,
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"id\":\"uta5d9j1kvwc\",\"name\":\"Test group 1\",\"configuration\":{},\"tests\":[{\"id\":\"awr8pq5vc9yp\",\"name\":\"MQTT Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}",
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole",
        "protocol": "MqttV3_1_1"
    },
    "createdAt": "2022-11-11T22:28:52.389000-05:00",
    "lastModifiedAt": "2022-11-11T22:28:52.389000-05:00",
    "tags": {}
}

詳細については、「 IoT Core デベロッパーガイド」の「テストスイート定義の取得」を参照してください。 AWS IoT

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

次の例は、get-suite-run-report を使用する方法を説明しています。

AWS CLI

IoT Device Advisor 認定テストスイート実行レポートに関する情報を取得するには

次のget-suite-run-report例では、指定されたスイート定義 ID とスイート実行 ID で正常に実行されたデバイスアドバイザー認定テストスイートに関するレポートダウンロードリンクを取得します。


aws iotdeviceadvisor get-suite-run-report \
    --suite-definition-id ztvb5aek4w4x \
    --suite-run-id p6awv83nre6v

出力:


{
    "qualificationReportDownloadUrl": "https://senate-apn-reports-us-east-1-prod.s3.amazonaws.com/report.downloadlink"
}

詳細については、AWS 「 IoT Core デベロッパーガイド」の「認定テストスイートが正常に実行されたための認定レポートを取得する」を参照してください。

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

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

AWS CLI

IoT Device Advisor テストスイートの実行ステータスに関する情報を取得するには

次のget-suite-run例では、指定されたスイート定義 ID とスイート実行 ID を持つデバイスアドバイザーテストスイート実行ステータスに関する情報を取得します。


aws iotdeviceadvisor get-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-run-id nzlfyhaa18oa

出力:


{
    "suiteDefinitionId": "qqcsmtyyjabl",
    "suiteDefinitionVersion": "v1",
    "suiteRunId": "nzlfyhaa18oa",
    "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/nzlfyhaa18oa",
    "suiteRunConfiguration": {
        "primaryDevice": {
            "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing",
            "certificateArn": "arn:aws:iot:us-east-1:123456789012:cert/certFile"
        },
        "parallelRun": false
    },
    "testResult": {
        "groups": [
            {
                "groupId": "uta5d9j1kvwc",
                "groupName": "Test group 1",
                "tests": [
                    {
                        "testCaseRunId": "2ve2twrqyr0s",
                        "testCaseDefinitionId": "awr8pq5vc9yp",
                        "testCaseDefinitionName": "MQTT Connect",
                        "status": "PASS",
                        "startTime": "2022-11-12T00:01:53.693000-05:00",
                        "endTime": "2022-11-12T00:02:15.443000-05:00",
                        "logUrl": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEventViewer:group=/aws/iot/deviceadvisor/qqcsmtyyjabl;stream=nzlfyhaa18oa_2ve2twrqyr0s",
                        "warnings": "null",
                        "failure": "null"
                    }
                ]
            }
        ]
    },
    "startTime": "2022-11-12T00:01:52.673000-05:00",
    "endTime": "2022-11-12T00:02:16.496000-05:00",
    "status": "PASS",
    "tags": {}
}

詳細については、「IoT Core デベロッパーガイド」の「テストスイートの実行を取得する」を参照してください。 AWS IoT

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

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

AWS CLI

例 1: 作成した IoT Device Advisor テストスイートを一覧表示するには

次のlist-suite-definitions例では、 AWS IoT で作成した最大 25 のデバイスアドバイザーテストスイートを一覧表示します。テストスイートが 25 を超える場合は、出力にnextToken「」が表示されます。このnextToken「」を使用して、作成した残りのテストスイートを表示できます。


aws iotdeviceadvisor list-suite-definitions

出力:


{
    "suiteDefinitionInformationList": [
        {
            "suiteDefinitionId": "3hsn88h4p2g5",
            "suiteDefinitionName": "TestSuite1",
            "defaultDevices": [
                {
                    "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"
                }
            ],
            "intendedForQualification": false,
            "isLongDurationTest": false,
            "protocol": "MqttV3_1_1",
            "createdAt": "2022-11-17T14:15:56.830000-05:00"
        },
        {
            ......
        }
    ],
    "nextToken": "nextTokenValue"
}

例 2: 指定した設定で作成した IoT Device Advisor テストスイートを一覧表示するには

次のlist-suite-definitions例では、IoT で作成したデバイスアドバイザーテストスイートを、指定された最大結果数 AWS IoT で一覧表示します。最大数よりも多くのテストスイートがある場合、出力にnextToken「」が表示されます。nextToken「」がある場合は、nextToken「」を使用して、以前に表示されなかったテストスイートを表示できます。


aws iotdeviceadvisor list-suite-definitions \
    --max-result 1 \
    --next-token "nextTokenValue"

出力:


{
    "suiteDefinitionInformationList": [
        {
            "suiteDefinitionId": "ztvb5aew4w4x",
            "suiteDefinitionName": "TestSuite2",
            "defaultDevices": [],
            "intendedForQualification": true,
            "isLongDurationTest": false,
            "protocol": "MqttV3_1_1",
            "createdAt": "2022-11-17T14:15:56.830000-05:00"
        }
    ],
    "nextToken": "nextTokenValue"
}

詳細については、AWS IoT APIリファレンス ListSuiteDefinitionsの「」を参照してください。

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

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

AWS CLI

例 1: 指定された IoT Device Advisor テストスイートの実行ステータスに関するすべての情報を一覧表示するには

次のlist-suite-runs例では、指定されたスイート定義 ID を持つデバイスアドバイザーテストスイートの実行ステータスに関するすべての情報を一覧表示します。25 回以上のテストスイートの実行がある場合、出力にnextToken「」が表示されます。このnextToken「」を使用して、残りのテストスイートの実行を表示できます。


aws iotdeviceadvisor list-suite-runs \
    --suite-definition-id ztvb5aew4w4x

出力:


{
    "suiteRunsList": [
        {
            "suiteDefinitionId": "ztvb5aew4w4x",
            "suiteDefinitionVersion": "v1",
            "suiteDefinitionName": "TestSuite",
            "suiteRunId": "p6awv89nre6v",
            "createdAt": "2022-12-01T16:33:14.212000-05:00",
            "startedAt": "2022-12-01T16:33:15.710000-05:00",
            "endAt": "2022-12-01T16:42:03.323000-05:00",
            "status": "PASS",
            "passed": 6,
            "failed": 0
        }
    ]
}

例 2: 指定された IoT Device Advisor テストスイートの実行ステータスに関する情報を指定された設定で一覧表示するには

次のlist-suite-runs例は、指定されたスイート定義 ID と指定された最大結果数を持つデバイスアドバイザーテストスイートの実行ステータスに関する情報を示しています。最大数よりも多くのテストスイート実行がある場合、出力にnextToken「」が表示されます。nextToken「」がある場合は、nextToken「」を使用して、以前に表示されなかったテストスイートの実行を表示できます。


aws iotdeviceadvisor list-suite-runs \
    --suite-definition-id qqcsmtyyjaml \
    --max-result 1 \
    --next-token "nextTokenValue"

出力:


{
    "suiteRunsList": [
        {
            "suiteDefinitionId": "qqcsmtyyjaml",
            "suiteDefinitionVersion": "v1",
            "suiteDefinitionName": "MQTT connection",
            "suiteRunId": "gz9vm2s6d2jy",
            "createdAt": "2022-12-01T20:10:27.079000-05:00",
            "startedAt": "2022-12-01T20:10:28.003000-05:00",
            "endAt": "2022-12-01T20:10:45.084000-05:00",
            "status": "STOPPED",
            "passed": 0,
            "failed": 0
        }
    ],
    "nextToken": "nextTokenValue"
}

詳細については、 AWS IoT APIリファレンスのListSuiteRuns「」を参照してください。

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

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

AWS CLI

IoT Device Advisor リソースにアタッチされたタグを一覧表示するには

次のlist-tags-for-resource例では、デバイスアドバイザーリソースにアタッチされたタグを一覧表示します。デバイスアドバイザーリソースは、Suitedefinition-Arn または Suiterun-Arn にすることができます。


aws iotdeviceadvisor list-tags-for-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny

出力:


{
    "tags": {
        "TestTagKey": "TestTagValue"
    }
}

詳細については、「サービス認証リファレンスListTagsForResource」の「IoT Core Device Advisor で定義される AWS IoT リファレンスとリソースタイプ」の「」を参照してください。 AWS IoT API

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

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

AWS CLI

IoT Device Advisor テストスイートの実行を開始するには

次のstart-suite-run例では、 AWS アカウントで使用可能なウィジェットを一覧表示します。


aws iotdeviceadvisor start-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-definition-version v1 \
    --suite-run-configuration '{"primaryDevice":{"thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing","certificateArn":"arn:aws:iot:us-east-1:123456789012:cert/certFile"}}'

出力:


{
    "suiteRunId": "pwmucgw7lt9s",
    "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/pwmucgw7lk9s",
    "createdAt": "2022-12-02T15:43:05.581000-05:00"
}

詳細については、「 IoT Core デベロッパーガイド」の「テストスイートの実行を開始するAWS IoT」を参照してください。

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

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

AWS CLI

現在実行中の IoT Device Advisor テストスイートを停止するには

次のstop-suite-run例では、指定されたスイート定義 ID とスイート実行 ID で現在実行されているデバイスアドバイザーテストスイートを停止します。


aws iotdeviceadvisor stop-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-run-id nzlfyhaa18oa

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

詳細については、「 IoT Core デベロッパーガイド」の「テストスイートの実行を停止AWS する IoT」を参照してください。

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

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

AWS CLI

IoT Device Advisor リソースの既存のタグに追加および変更するには

次のtag-resource例では、指定されたリソース ARN とタグを使用して、デバイスアドバイザーリソースの既存のタグをに追加して変更します。デバイスアドバイザーリソースは、Suitedefinition-Arn または Suiterun-Arn にすることができます。


aws iotdeviceadvisor tag-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \
    --tags '{"TagKey": "TagValue"}'

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

詳細については、「サービス認証リファレンスTagResource」の「IoT Core Device Advisor で定義される AWS IoT リファレンスとリソースタイプ」の「」を参照してください。 AWS IoT API

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

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

AWS CLI

IoT Device Advisor リソースから既存のタグを削除するには

次のuntag-resource例では、指定されたリソース ARN とタグキーを持つデバイスアドバイザーリソースから既存のタグを削除します。デバイスアドバイザーリソースは、Suitedefinition-Arn または Suiterun-Arn にすることができます。


aws iotdeviceadvisor untag-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \
    --tag-keys "TagKey"

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

詳細については、「サービス認証リファレンスUntagResource」の「IoT Core Device Advisor で定義される AWS IoT リファレンスとリソースタイプ」の「」を参照してください。 AWS IoT API

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

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

AWS CLI

例 1: IoT Device Advisor テストスイートを更新するには

次のupdate-suite-definition例では、指定されたスイート定義 ID とスイート定義設定を使用して AWS IoT のデバイスアドバイザーテストスイートを更新します。


aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id 3hsn88h4p2g5 \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": false, \
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

出力:


{
    "suiteDefinitionId": "3hsn88h4p2g5",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

例 2: IoT Device Advisor 認定テストスイートを更新するには

次のupdate-suite-definition例では、指定されたスイート定義 ID とスイート定義設定を使用して AWS IoT のデバイスアドバイザー認定テストスイートを更新します。


aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id txgsuolk2myj \
    --suite-definition-configuration '{
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": true, \
        "rootGroup": "", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

出力:


{
    "suiteDefinitionId": "txgsuolk2myj",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

詳細については、AWS IoT APIリファレンスのUpdateSuiteDefinition「」を参照してください。

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

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

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

ドキュメントの表記規則

AWS IoT Analytics

AWS IoT data