Esempi di Device Advisor che utilizzano AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with Device Advisor.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Azioni

Il seguente esempio di codice mostra come utilizzarecreate-suite-definition.

AWS CLI

Esempio 1: come creare una suite di test IoT Device Advisor

L'create-suite-definitionesempio seguente crea una suite di test Device Advisor nell' AWS IoT con la configurazione di definizione della suite specificata.


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

Output:


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

Per ulteriori informazioni, consulta Creare una definizione di suite di test nella Guida per gli sviluppatori di AWS IoT Core.

Esempio 2: come creare una suite di test di qualificazione più recente di IoT Device Advisor

L'create-suite-definitionesempio seguente crea una suite di test di qualificazione Device Advisor con la versione più recente dell' AWS IoT con la configurazione di definizione della suite specificata.


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

Output:


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

Per ulteriori informazioni, consulta Creare una definizione di suite di test nella Guida per gli sviluppatori di AWS IoT Core.

Per i dettagli sull'API, vedere CreateSuiteDefinitionin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaredelete-suite-definition.

AWS CLI

Come eliminare la suite di test IoT Device Advisor

L’esempio delete-suite-definition seguente elimina la suite di test Device Advisor con l’ID di definizione della suite specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta la DeleteSuiteDefinitionsezione AWS IoT API Reference.

Per i dettagli sull'API, consulta DeleteSuiteDefinition AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-endpoint.

AWS CLI

Esempio 1: come ottenere informazioni su un endpoint a livello di account di IoT Device Advisor

L’esempio get-endpoint seguente ottiene le informazioni su un endpoint di test a livello di account di Device Advisor.


aws iotdeviceadvisor get-endpoint

Output:


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

Esempio 2: come ottenere informazioni su un endpoint a livello di dispositivo di IoT Device Advisor

L’esempio get-endpoint seguente ottiene le informazioni su un endpoint di test a livello di dispositivo di Device Advisor con il thing-arn o il certificate-arn specificato.


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

Output:


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

Per ulteriori informazioni, consulta Ottenere un endpoint di test nella Guida per gli sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta GetEndpoint AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-suite-definition.

AWS CLI

Come ottenere informazioni su una suite di test IoT Device Advisor

L’esempio get-suite-definition seguente ottiene le informazioni su una suite di test Device Advisor con l’ID di definizione della suite specificato.


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

Output:


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

Per ulteriori informazioni, consulta Ottenere una definizione di suite di test nella Guida per gli sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta GetSuiteDefinition AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-suite-run-report.

AWS CLI

Come ottenere informazioni sul report di esecuzione di una suite di test qualificata per IoT Device Advisor

L’esempio get-suite-run-report seguente ottiene il link per il download del rapporto relativo all’esecuzione di una suite di test qualificata per Device Advisor con successo con l’ID di definizione della suite e l’ID di esecuzione della suite specificati.


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

Output:


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

Per ulteriori informazioni, consulta Ottenere un rapporto di qualificazione per una suite di test di qualificazione riuscita nella Guida gli per sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta GetSuiteRunReport AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-suite-run.

AWS CLI

Come ottenere informazioni sullo stato di esecuzione di una suite di test IoT Device Advisor

L’esempio get-suite-run seguente ottiene le informazioni sullo stato di esecuzione di una suite di test Device Advisor con l’ID di definizione della suite e l’ID di esecuzione della suite specificati.


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

Output:


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

Per ulteriori informazioni, consulta Ottenere un’esecuzione della suite di test nella Guida gli per sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta GetSuiteRun AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-suite-definitions.

AWS CLI

Esempio 1: come elencare le suite di test IoT Device Advisor create con le impostazioni specificate

L'list-suite-definitionsesempio seguente elenca fino a 25 suite di test Device Advisor create in AWS IoT. Se hai più di 25 suite di test, nell’output verrà mostrato il valore “nextToken”. Puoi utilizzare “nextToken” per mostrare il resto delle suite di test che hai creato.


aws iotdeviceadvisor list-suite-definitions

Output:


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

Esempio 2: come elencare le suite di test IoT Device Advisor create con le impostazioni specificate

L'list-suite-definitionsesempio seguente elenca le suite di test Device Advisor create in AWS IoT con il numero massimo di risultati specificato. Se hai più suite di test rispetto al numero massimo, nell’output verrà mostrato il valore “nextToken”. Se è presente “nextToken”, è possibile utilizzarlo per mostrare le suite di test create che non lo erano mai state prima.


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

Output:


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

Per ulteriori informazioni, consulta la ListSuiteDefinitionssezione AWS IoT API Reference.

Per i dettagli sull'API, consulta ListSuiteDefinitions AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-suite-runs.

AWS CLI

Esempio 1: come elencare tutte le informazioni sullo stato di esecuzione della suite di test IoT Device Advisor specificata

L’esempio list-suite-runs seguente elenca tutte le informazioni sullo stato di esecuzione della suite di test Device Advisor con l’ID di definizione della suite specificato. Se sono presenti più di 25 esecuzioni della suite di test, nell’output verrà mostrato il valore “nextToken”. Puoi utilizzare “nextToken” per mostrare il resto delle esecuzioni della suite di test.


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

Output:


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

Esempio 2: come elencare le informazioni sullo stato di esecuzione della suite di test IoT Device Advisor specificata con le impostazioni specificate

L’esempio list-suite-runs seguente elenca le informazioni sullo stato di esecuzione della suite di test Device Advisor con l’ID di definizione della suite specificato e il numero massimo di risultati specificato. Se hai più esecuzioni della suite di test rispetto al numero massimo, nell’output verrà mostrato il valore “nextToken”. Se è presente “nextToken”, è possibile utilizzarlo per mostrare le esecuzioni della suite di test create che non lo erano mai state prima.


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

Output:


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

Per ulteriori informazioni, consulta la ListSuiteRunssezione AWS IoT API Reference.

Per i dettagli sull'API, consulta ListSuiteRuns AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come elencare i tag allegati a una risorsa IoT Device Advisor

L’esempio list-tags-for-resource seguente elenca i tag associati a una risorsa Device Advisor. La risorsa Device Advisor può essere Suitedefinition-Arn o Suiterun-Arn.


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

Output:


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

Per ulteriori informazioni, vedere il riferimento ListTagsForResourceall'API AWS IoT e i tipi di risorse definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

Per i dettagli sull'API, consulta ListTagsForResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarestart-suite-run.

AWS CLI

Come avviare l’esecuzione di una suite di test IoT Device Advisor

L'start-suite-runesempio seguente elenca i widget disponibili nel tuo AWS account.


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

Output:


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

Per ulteriori informazioni, consulta Avviare una suite di test nella Guida per gli sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta StartSuiteRun AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarestop-suite-run.

AWS CLI

Come arrestare una suite di test IoT Device Advisor attualmente in esecuzione

L’esempio stop-suite-run seguente arresta una suite di test Device Advisor attualmente in esecuzione con l’ID di definizione della suite e l’ID di esecuzione della suite specificati.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Interrompere l’esecuzione di una suite di test nella Guida per gli sviluppatori di AWS IoT Core.

Per i dettagli sull'API, consulta StopSuiteRun AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Come aggiungere e modificare i tag esistenti di una risorsa IoT Device Advisor

L’esempio tag-resource seguente aggiunge e modifica i tag esistenti di una risorsa Device Advisor con la risorsa arn e i tag specificati. La risorsa Device Advisor può essere Suitedefinition-Arn o Suiterun-Arn.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere il riferimento TagResourceall'API AWS IoT e i tipi di risorse definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

Per i dettagli sull'API, consulta TagResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Come rimuovere i tag esistenti da una risorsa IoT Device Advisor

L’esempio untag-resource seguente rimuove i tag esistenti da una risorsa Device Advisor con la risorsa arn e la chiave tag specificati. La risorsa Device Advisor può essere Suitedefinition-Arn o Suiterun-Arn.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere il riferimento UntagResourceall'API AWS IoT e i tipi di risorse definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

Per i dettagli sull'API, consulta UntagResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-suite-definition.

AWS CLI

Esempio 1: come aggiornare una suite di test IoT Device Advisor

L'update-suite-definitionesempio seguente aggiorna una suite di test Device Advisor nell' AWS IoT con l'ID di definizione della suite e la configurazione della definizione della suite specificati.


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

Output:


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

Esempio 2: come aggiornare una suite di test di qualificazione di IoT Device Advisor

L'update-suite-definitionesempio seguente aggiorna una suite di test di qualificazione Device Advisor nell' AWS IoT con l'ID di definizione della suite e la configurazione della definizione della suite specificati.


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

Output:


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

Per ulteriori informazioni, consulta la UpdateSuiteDefinitionsezione AWS IoT API Reference.

Per i dettagli sull'API, consulta UpdateSuiteDefinition AWS CLICommand Reference.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

AWS IoT Analytics

AWS IoT data