Esempi di Device Advisor utilizzando AWS CLI - AWS Command Line Interface
Azioni

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Esempi di Device Advisor utilizzando AWS CLI

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

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

Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

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

AWS CLI

Esempio 1: 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 AWS IoT Core Developer Guide.

Esempio 2: 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 AWS IoT Core Developer Guide.

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

AWS CLI

Per eliminare la suite di test IoT Device Advisor

L'delete-suite-definitionesempio 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, DeleteSuiteDefinitionconsulta AWS IoT API Reference.

Il seguente esempio di codice mostra come utilizzareget-endpoint.

AWS CLI

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

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

aws iotdeviceadvisor get-endpoint

Output:

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

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

L'get-endpointesempio seguente ottiene le informazioni su un endpoint di test a livello di dispositivo Device Advisor con il thing-arn o 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 Get a test endpoint nella AWS IoT Core Developer Guide.

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

AWS CLI

Per ottenere informazioni su una suite di test IoT Device Advisor

L'get-suite-definitionesempio seguente ottiene le informazioni su una suite di test adevice 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 Get a test suite definition nella AWS IoT Core Developer Guide.

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

AWS CLI

Per ottenere informazioni sull'esecuzione di una suite di test qualificata per IoT Device Advisor

L'get-suite-run-reportesempio 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 eseguita con successo nella AWS IoT Core Developer Guide.

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

AWS CLI

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

L'get-suite-runesempio 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 Get a test suite run nella AWS IoT Core Developer Guide.

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

AWS CLI

Esempio 1: per elencare le suite di test IoT Device Advisor che hai creato

L'list-suite-definitionsesempio seguente elenca fino a 25 suite di test Device Advisor create in AWS IoT. Se disponi di più di 25 suite di test, nell'output verrà visualizzato nextToken "". Puoi usare questo "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: per 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 disponi di più suite di test rispetto al numero massimo, nell'nextTokenoutput verrà visualizzato "". Se hai "nextToken«, puoi usare" nextToken "per mostrare le suite di test che hai creato e che non erano mai state mostrate 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, ListSuiteDefinitionsconsulta AWS IoT API Reference.

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

AWS CLI

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

L'list-suite-runsesempio 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 state eseguite più di 25 suite di test, nell'output verrà visualizzato nextToken "". Puoi usare questo "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: per elencare le informazioni sulla suite di test IoT Device Advisor specificata, esegue lo stato con le impostazioni specificate

L'list-suite-runsesempio 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 il numero di esecuzioni della suite di test è superiore al numero massimo, nell'output verrà visualizzato nextToken "". Se hai "nextToken«, puoi usare" nextToken "per mostrare le esecuzioni della suite di test che non erano state mostrate 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, ListSuiteRunsconsulta AWS IoT API Reference.

  • Per API i dettagli, vedere ListSuiteRunsin AWS CLI Command Reference.

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

AWS CLI

Per elencare i tag allegati a una risorsa IoT Device Advisor

L'list-tags-for-resourceesempio seguente elenca i tag allegati 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 ListTagsForResource AWSIoT API Reference and Resource types definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

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

AWS CLI

Per 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 l'esecuzione di una suite di test nella AWS IoT Core Developer Guide.

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

AWS CLI

Per interrompere una suite di test IoT Device Advisor attualmente in esecuzione

L'stop-suite-runesempio seguente interrompe 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 Stop a test suite run nella AWS IoT Core Developer Guide.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

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

L'tag-resourceesempio 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 TagResource AWSIoT API Reference and Resource types definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

  • Per API i dettagli, vedere TagResourcein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Per rimuovere i tag esistenti da una risorsa IoT Device Advisor

L'untag-resourceesempio 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 un Suitedefinition-Arn o un 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 UntagResource AWSIoT API Reference and Resource types definiti da AWS IoT Core Device Advisor nel Service Authorization Reference.

  • Per API i dettagli, vedere UntagResourcein AWS CLI Command Reference.

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

AWS CLI

Esempio 1: 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: aggiornare una suite di test di qualificazione 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, UpdateSuiteDefinitionconsulta AWS IoT API Reference.