Beispiele für die Verwendung der AWS CLI mit Device Advisor

Beispiel 1: So erstellen Sie eine Testsuite für IoT Device Advisor

Im folgenden create-suite-definition-Beispiel wird eine Testsuite von Device Advisor im AWS IoT mit der angegebenen Konfiguration für die Suite-Definition 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 Entwicklerhandbuch zu AWS IoT Core.

Beispiel 2: So erstellen Sie eine Qualifizierungs-Testsuite für IoT Device Advisor

Im folgenden create-suite-definition-Beispiel wird eine Qualifizierungs-Testsuite von Device Advisor mit der neuesten Version im AWS IoT mit der angegebenen Konfiguration für die Suite-Definition 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 Entwicklerhandbuch zu AWS IoT Core.

So löschen Sie die Testsuite von IoT Device Advisor

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

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter DeleteSuiteDefinition in der API-Referenz zu AWS IoT.

Beispiel 1: So rufen Sie die Informationen über einen Endpunkt auf Kontoebene von IoT Device Advisor ab

Im folgenden get-endpoint-Beispiel werden die Informationen über einen Test-Endpunkt auf Kontoebene von Device Advisor abgerufen.

aws iotdeviceadvisor get-endpoint

Ausgabe:

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

Beispiel 2: So rufen Sie die Informationen über einen Endpunkt auf Geräteebene von IoT Device Advisor ab

Im folgenden get-endpoint-Beispiel werden die Informationen über einen Test-Endpunkt auf Geräteebene von Device Advisor mit dem angegebenen Objekt-ARN oder Zertifikat-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 Abrufen eines Testendpunkts im Entwicklerhandbuch zu AWS IoT Core.

So rufen Sie Informationen über eine Testsuite von IoT Device Advisor ab

Im folgenden get-suite-definition-Beispiel werden die Informationen über eine Testsuite von Device Advisor mit der angegebenen Suite-Definitions-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 Abrufen einer Testsuite-Definition im Entwicklerhandbuch zu AWS IoT Core.

So rufen Sie Informationen über den Bericht zur Ausführung einer Qualifizierungs-Testsuite von IoT Device Advisor ab

Im folgenden get-suite-run-report-Beispiel wird der Link zum Herunterladen des Berichts für eine erfolgreiche Ausführung einer Qualifizierungs-Testsuite von IoT Device Advisor mit der angegebenen Suite-Definitions-ID und Suite-Ausführungs-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 unter Abrufen eines Qualifizierungsberichts für eine erfolgreiche Ausführung der Qualifizierungstestsuite im Entwicklerhandbuch zu AWS IoT Core.

So rufen Sie Informationen über den Ausführungsstatus einer Testsuite von IoT Device Advisor ab

Im folgenden get-suite-run-Beispiel werden die Informationen über den Ausführungsstatus einer Testsuite von Device Advisor mit der angegebenen Suite-Definitions-ID und Suite-Ausführungs-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 Abrufen einer Testsuite-Ausführung im Entwicklerhandbuch zu AWS IoT Core.

Beispiel 1: So listen Sie die von Ihnen erstellten Testsuites von IoT Device Advisor auf

Im folgenden list-suite-definitions-Beispiel werden bis zu 25 Testsuites von Device Advisor aufgelistet, die Sie in AWS IoT erstellt haben. Wenn Sie mehr als 25 Testsuiten haben, wird „nextToken“ in der Ausgabe angezeigt. Sie können „nextToken“ verwenden, um den Rest der von Ihnen erstellten Testsuites 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: So listen Sie die Testsuites von IoT Device Advisor auf, die Sie mit den angegebenen Einstellungen erstellt haben

Im folgenden list-suite-definitions-Beispiel werden Testsuites von Device Advisor aufgelistet, die Sie in AWS IoT mit der angegebenen maximalen Ergebniszahl erstellt haben. Wenn die Zahl Ihrer Testsuites die maximale Anzahl übersteigt, wird „nextToken“ in der Ausgabe angezeigt. Wenn Sie „nextToken“ haben, können Sie den Wert verwenden, um die von Ihnen erstellten Testsuites 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 unter ListSuiteDefinitions in der API-Referenz zu AWS IoT.

Beispiel 1: So listen Sie alle Informationen über den Ausführungsstatus der angegebenen Testsuite von IoT Device Advisor auf

Im folgenden list-suite-runs-Beispiel werden alle Informationen über den Ausführungsstatus einer Testsuite von Device Advisor mit der angegebenen Suite-Definitions-ID aufgelistet. Wenn Sie mehr als 25 Testsuite-Ausführungen haben, wird „nextToken“ in der Ausgabe angezeigt. Sie können „nextToken“ verwenden, um die restlichen Testsuite-Ausführungen 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: So listen Sie Informationen über den Ausführungsstatus der angegebenen Testsuite von IoT Device Advisor mit den angegebenen Einstellungen auf

Im folgenden list-suite-runs-Beispiel werden Informationen über den Ausführungsstatus einer Testsuite von Device Advisor mit der angegebenen Suite-Definitions-ID und der angegebenen maximalen Ergebniszahl aufgelistet. Wenn die Zahl Ihrer Testsuite-Ausführungen die maximale Anzahl übersteigt, wird „nextToken“ in der Ausgabe angezeigt. Wenn Sie „nextToken“ haben, können Sie den Wert verwenden, um die Testsuite-Ausführungen 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 unter ListSuiteRuns in der API-Referenz zu AWS IoT.

So listen Sie die Tags auf, die an eine Ressource von IoT Device Advisor angehängt sind

Im folgenden list-tags-for-resource-Beispiel werden die Tags aufgelistet, die an eine Ressource von Device Advisor angehängt sind Die Ressource von Device Advisor kann ein Suite-Definitions-ARN oder ein Suite-Ausführungs-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 unter ListTagsForResource in der API-Referenz zu AWS IoT und unter Von AWS IoT Core Device Advisor definierte Ressourcentypen in der Service-Authorization-Referenz.

So starten Sie die Ausführung einer Testsuite von IoT Device Advisor

Im folgenden start-suite-run-Beispiel werden die verfügbaren Widgets in Ihrem AWS-Konto aufgelistet.

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 Entwicklerhandbuch zu AWS IoT Core.

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

Im folgenden stop-suite-run-Beispiel wird eine Testsuite von Device Advisor mit der angegebenen Suite-Definitions-ID und Suite-Ausführungs-ID, die derzeit ausgeführt wird, beendet.

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 Entwicklerhandbuch zu AWS IoT Core.

So fügen Sie die vorhandenen Tags einer Ressource von IoT Device Advisor hinzu und ändern sie

Im folgenden tag-resource-Beispiel werden die vorhandenen Tags einer Ressource von Device Advisor mit dem angegebenen Ressourcen-ARN und den angegebenen Tags hinzugefügt und geändert. Die Ressource von Device Advisor kann ein Suite-Definitions-ARN oder ein Suite-Ausführungs-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 unter TagResource in der API-Referenz zu AWS IoT und unter Von AWS IoT Core Device Advisor definierte Ressourcentypen in der Service-Authorization-Referenz.

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

Im folgenden untag-resource-Beispiel werden die vorhandenen Tags aus einer Ressource von Device Advisor mit dem angegebenen Ressourcen-ARN und den angegebenen Tags entfernt. Die Ressource von Device Advisor kann ein Suite-Definitions-ARN oder ein Suite-Ausführungs-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 unter UntagResource in der API-Referenz zu AWS IoT und unter Von AWS IoT Core Device Advisor definierte Ressourcentypen in der Service-Authorization-Referenz.

Beispiel 1: So aktualisieren Sie eine Testsuite für IoT Device Advisor

Im folgenden update-suite-definition-Beispiel wird eine Testsuite von Device Advisor im AWS IoT mit der angegebenen ID für die Suite-Definition und der Konfiguration für die Suite-Definition aktualisiert.

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 Qualifizierungs-Testsuite für IoT Device Advisor

Im folgenden update-suite-definition-Beispiel wird eine Qualifizierungs-Testsuite von Device Advisor im AWS IoT mit der angegebenen ID für die Suite-Definition und der Konfiguration für die Suite-Definition 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 unter UpdateSuiteDefinition in der API-Referenz zu AWS IoT.