Device Advisor-Beispiele mit AWS CLI - AWS Command Line Interface

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Device Advisor-Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie AWS Command Line Interface mit Device Advisor Aktionen ausführen und allgemeine Szenarien implementieren.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Servicefunktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien und serviceübergreifenden Beispiele sehen.

Szenarien sind Codebeispiele, die Ihnen zeigen, wie Sie eine bestimmte Aufgabe ausführen können, indem Sie mehrere Funktionen innerhalb desselben Services aufrufen.

Jedes Beispiel enthält einen Link zu GitHub, wo Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-suite-definition.

AWS CLI

Beispiel 1: So erstellen Sie eine IoT Device Advisor-Testsuite

Im folgenden create-suite-definition Beispiel wird eine Device Advisor-Testsuite im AWS IoT mit der angegebenen Suite-Definitionskonfiguration erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen einer Testsuite-Definition im AWS IoT Core Developer Guide.

Beispiel 2: So erstellen Sie eine Testsuite für die neueste Qualifikation von IoT Device Advisor

Im folgenden create-suite-definition Beispiel wird eine Device Advisor-Qualifizierungstestsuite mit der neuesten Version im AWS IoT mit der angegebenen Suite-Definitionskonfiguration erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen einer Testsuite-Definition im AWS IoT Core Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdelete-suite-definition.

AWS CLI

So löschen Sie die IoT Device Advisor-Testsuite

Im folgenden delete-suite-definition Beispiel wird die Device Advisor-Testsuite mit der angegebenen Suite-Definition-ID gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie DeleteSuiteDefinitionin der AWS IoT-API-Referenz.

Das folgende Codebeispiel zeigt die Verwendungget-endpoint.

AWS CLI

Beispiel 1: Um die Informationen über einen IoT Device Advisor-Endpunkt auf Kontoebene abzurufen

Im folgenden get-endpoint Beispiel werden die Informationen zu einem Testendpunkt auf Device Advisor-Kontoebene abgerufen.

aws iotdeviceadvisor get-endpoint

Ausgabe:

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

Beispiel 2: Um die Informationen über einen IoT Device Advisor-Endpunkt auf Geräteebene abzurufen

Im folgenden get-endpoint Beispiel werden die Informationen zu einem Device Advisor-Testendpunkt auf Geräteebene mit dem angegebenen Thing-ARN oder Certificate-ARN abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Holen Sie sich einen Testendpunkt im AWS IoT Core Developer Guide.

  • Einzelheiten zur API finden Sie GetEndpointunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-suite-definition.

AWS CLI

Um Informationen über eine IoT Device Advisor-Testsuite zu erhalten

Im folgenden get-suite-definition Beispiel werden die Informationen zu einer ADevice Advisor-Testsuite mit der angegebenen Suite-Definition-ID abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Get a Test Suite-Definition im AWS IoT Core Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungget-suite-run-report.

AWS CLI

Um Informationen zu einer qualifizierten Testsuite für IoT Device Advisor zu erhalten, führen Sie einen Bericht aus

Im folgenden get-suite-run-report Beispiel wird der Link zum Herunterladen des Berichts für eine erfolgreiche Ausführung einer für Device Advisor qualifizierten Testsuite mit der angegebenen Suite-Definition-ID und Suite-Run-ID abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie im AWS IoT Core Developer Guide unter Einen Qualifizierungsbericht für eine erfolgreiche Ausführung einer Qualifizierungstestsuite abrufen.

Das folgende Codebeispiel zeigt die Verwendungget-suite-run.

AWS CLI

Um Informationen zum Ausführungsstatus einer IoT Device Advisor-Testsuite abzurufen

Im folgenden get-suite-run Beispiel werden die Informationen zum Ausführungsstatus einer Device Advisor-Testsuite mit der angegebenen Suite-Definition-ID und Suite-Run-ID abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Get a Test Suite Run im AWS IoT Core Developer Guide.

  • Einzelheiten zur API finden Sie GetSuiteRununter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-suite-definitions.

AWS CLI

Beispiel 1: Um die von Ihnen erstellten IoT Device Advisor-Testsuiten aufzulisten

Das folgende list-suite-definitions Beispiel listet bis zu 25 Device Advisor-Testsuiten auf, die Sie in AWS IoT erstellt haben. Wenn Sie mehr als 25 Testsuiten haben, wird das „nextToken“ in der Ausgabe angezeigt. Sie können dieses „nextToken“ verwenden, um den Rest der von Ihnen erstellten Testsuiten anzuzeigen.

aws iotdeviceadvisor list-suite-definitions

Ausgabe:

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

Beispiel 2: Um die IoT Device Advisor-Testsuiten aufzulisten, die Sie mit den angegebenen Einstellungen erstellt haben

Das folgende list-suite-definitions Beispiel listet Device Advisor-Testsuiten auf, die Sie in AWS IoT mit der angegebenen maximalen Ergebniszahl erstellt haben. Wenn Sie mehr Testsuiten als die maximale Anzahl haben, wird das „nextToken“ in der Ausgabe angezeigt. Wenn Sie „nextToken“ haben, können Sie „nextToken“ verwenden, um die von Ihnen erstellten Testsuiten anzuzeigen, die zuvor nicht angezeigt wurden.

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

Ausgabe:

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

Weitere Informationen finden Sie ListSuiteDefinitionsin der AWS IoT-API-Referenz.

Das folgende Codebeispiel zeigt die Verwendunglist-suite-runs.

AWS CLI

Beispiel 1: Um alle Informationen über den angegebenen Status der IoT Device Advisor-Testsuite aufzulisten

Im folgenden list-suite-runs Beispiel werden alle Informationen zum Ausführungsstatus einer Device Advisor-Testsuite mit der angegebenen Suite-Definition-ID aufgeführt. Wenn Sie mehr als 25 Testsuite-Läufe haben, wird das „nextToken“ in der Ausgabe angezeigt. Sie können dieses „nextToken“ verwenden, um den Rest der Testsuite-Läufe anzuzeigen.

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

Ausgabe:

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

Beispiel 2: Um Informationen über den angegebenen IoT Device Advisor-Testsuite-Ausführungsstatus mit den angegebenen Einstellungen aufzulisten

Im folgenden list-suite-runs Beispiel werden Informationen zum Ausführungsstatus einer Device Advisor-Testsuite mit der angegebenen Suite-Definition-ID und der angegebenen maximalen Ergebniszahl aufgeführt. Wenn Sie mehr Testsuite-Läufe als die maximale Anzahl haben, wird das „nextToken“ in der Ausgabe angezeigt. Wenn Sie „nextToken“ haben, können Sie „nextToken“ verwenden, um die Testsuite-Läufe anzuzeigen, die zuvor nicht angezeigt wurden.

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

Ausgabe:

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

Weitere Informationen finden Sie ListSuiteRunsin der AWS IoT-API-Referenz.

  • Einzelheiten zur API finden Sie ListSuiteRunsunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um die an eine IoT Device Advisor-Ressource angehängten Tags aufzulisten

Das folgende list-tags-for-resource Beispiel listet die Tags auf, die an eine Device Advisor-Ressource angehängt sind. Die Device Advisor-Ressource kann ein Suitedefinition-Arn oder ein Suiterun-Arn sein.

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

Ausgabe:

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

Weitere Informationen finden Sie ListTagsForResourcein der AWS IoT-API-Referenz und unter Ressourcentypen, die von AWS IoT Core Device Advisor definiert wurden, in der Service Authorization Reference.

Das folgende Codebeispiel zeigt die Verwendungstart-suite-run.

AWS CLI

Um eine IoT Device Advisor-Testsuite zu starten, führen Sie

Das folgende start-suite-run Beispiel listet die verfügbaren Widgets in Ihrem AWS Konto auf.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Starten einer Testsuite-Ausführung im AWS IoT Core Developer Guide.

  • Einzelheiten zur API finden Sie StartSuiteRununter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungstop-suite-run.

AWS CLI

So beenden Sie eine IoT Device Advisor-Testsuite, die gerade ausgeführt wird

Im folgenden stop-suite-run Beispiel wird eine Device Advisor-Testsuite gestoppt, die derzeit mit der angegebenen Suite-Definition-ID und Suite-Run-ID ausgeführt wird.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Beenden einer Testsuite-Ausführung im AWS IoT Core Developer Guide.

  • Einzelheiten zur API finden Sie StopSuiteRununter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um die vorhandenen Tags einer IoT Device Advisor-Ressource hinzuzufügen und zu ändern

Im folgenden tag-resource Beispiel werden die vorhandenen Tags einer Device Advisor-Ressource um den angegebenen Ressourcen-ARN und die angegebenen Tags erweitert und geändert. Die Device Advisor-Ressource kann ein Suitedefinition-Arn oder ein Suiterun-Arn sein.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie TagResourcein der AWS IoT-API-Referenz und unter Ressourcentypen, die von AWS IoT Core Device Advisor definiert wurden, in der Service Authorization Reference.

  • Einzelheiten zur API finden Sie TagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

So entfernen Sie die vorhandenen Tags aus einer IoT Device Advisor-Ressource

Im folgenden untag-resource Beispiel werden die vorhandenen Tags mit dem angegebenen Ressourcen-ARN und Tag-Schlüssel aus einer Device Advisor-Ressource entfernt. Die Device Advisor-Ressource kann ein Suitedefinition-Arn oder ein Suiterun-Arn sein.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie UntagResourcein der AWS IoT-API-Referenz und unter Ressourcentypen, die von AWS IoT Core Device Advisor definiert wurden, in der Service Authorization Reference.

  • Einzelheiten zur API finden Sie UntagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-suite-definition.

AWS CLI

Beispiel 1: So aktualisieren Sie eine IoT Device Advisor-Testsuite

Das folgende update-suite-definition Beispiel aktualisiert eine Device Advisor-Testsuite im AWS IoT mit der angegebenen Suite-Definition-ID und der Suite-Definitionskonfiguration.

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

Ausgabe:

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

Beispiel 2: So aktualisieren Sie eine IoT Device Advisor-Qualifizierungstestsuite

Im folgenden update-suite-definition Beispiel wird eine Device Advisor-Qualifizierungstestsuite im AWS IoT mit der angegebenen Suite-Definition-ID und der Suite-Definitionskonfiguration aktualisiert.

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

Ausgabe:

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

Weitere Informationen finden Sie UpdateSuiteDefinitionin der AWS IoT-API-Referenz.