Exemples d'utilisation de Device Advisor AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide de Device Advisor.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utilisercreate-suite-definition.

AWS CLI

Exemple 1 : pour créer une suite de tests IoT Device Advisor

L'create-suite-definitionexemple suivant crée une suite de tests Device Advisor dans l' AWS IoT avec la configuration de définition de suite spécifiée.


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

Sortie :


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

Pour plus d'informations, consultez la section Création d'une définition de suite de tests dans le guide du développeur AWS IoT Core.

Exemple 2 : pour créer une suite de tests de qualification IoT Device Advisor Latest

L'create-suite-definitionexemple suivant crée une suite de tests de qualification Device Advisor avec la dernière version de l' AWS IoT avec la configuration de définition de suite spécifiée.


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

Sortie :


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

Pour plus d'informations, consultez la section Création d'une définition de suite de tests dans le guide du développeur AWS IoT Core.

Pour API plus de détails, voir CreateSuiteDefinitionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-suite-definition.

AWS CLI

Pour supprimer la suite de tests IoT Device Advisor

L'delete-suite-definitionexemple suivant supprime la suite de tests Device Advisor avec l'ID de définition de suite spécifié.


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez le DeleteSuiteDefinitionmanuel de APIréférence sur l'AWS IoT.

Pour API plus de détails, voir DeleteSuiteDefinitionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-endpoint.

AWS CLI

Exemple 1 : pour obtenir des informations sur un point de terminaison au niveau du compte IoT Device Advisor

L'get-endpointexemple suivant permet d'obtenir les informations relatives à un point de terminaison de test au niveau du compte Device Advisor.


aws iotdeviceadvisor get-endpoint

Sortie :


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

Exemple 2 : Pour obtenir des informations sur un point de terminaison au niveau de l'appareil IoT Device Advisor

L'get-endpointexemple suivant obtient les informations relatives à un point de terminaison de test Device Advisor au niveau de l'appareil avec le thing-arn ou le certificate-arn spécifié.


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

Sortie :


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

Pour plus d'informations, consultez la section Obtenir un point de terminaison de test dans le guide du développeur AWS IoT Core.

Pour API plus de détails, voir GetEndpointla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-suite-definition.

AWS CLI

Pour obtenir des informations sur une suite de tests IoT Device Advisor

L'get-suite-definitionexemple suivant permet d'obtenir les informations relatives à une suite de tests Advice Advisor avec l'ID de définition de suite spécifié.


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

Sortie :


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

Pour plus d'informations, voir Obtenir une définition de suite de tests dans le Guide du développeur AWS IoT Core.

Pour API plus de détails, voir GetSuiteDefinitionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-suite-run-report.

AWS CLI

Pour obtenir des informations sur une suite de tests de qualification pour IoT Device Advisor, exécutez un rapport

L'get-suite-run-reportexemple suivant permet d'obtenir le lien de téléchargement du rapport pour une suite de tests de qualification de Device Advisor exécutée avec succès avec l'ID de définition de suite et l'ID d'exécution de suite spécifiés.


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

Sortie :


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

Pour plus d'informations, voir Obtenir un rapport de qualification pour une suite de tests de qualification exécutée avec succès dans le Guide du développeur AWS IoT Core.

Pour API plus de détails, voir GetSuiteRunReportla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-suite-run.

AWS CLI

Pour obtenir des informations sur l'état d'exécution d'une suite de tests IoT Device Advisor

L'get-suite-runexemple suivant permet d'obtenir les informations relatives à l'état d'exécution d'une suite de tests Device Advisor avec l'ID de définition de suite et l'ID d'exécution de la suite spécifiés.


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

Sortie :


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

Pour plus d'informations, consultez la section Faire exécuter une suite de tests dans le Guide du développeur AWS IoT Core.

Pour API plus de détails, voir GetSuiteRunla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-suite-definitions.

AWS CLI

Exemple 1 : pour répertorier les suites de tests IoT Device Advisor que vous avez créées

L'list-suite-definitionsexemple suivant répertorie jusqu'à 25 suites de tests Device Advisor que vous avez créées dans AWS l'IoT. Si vous avez plus de 25 suites de tests, le nextToken « » sera affiché dans la sortie. Vous pouvez utiliser ce « nextToken » pour afficher le reste des suites de tests que vous avez créées.


aws iotdeviceadvisor list-suite-definitions

Sortie :


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

Exemple 2 : pour répertorier les suites de test IoT Device Advisor que vous avez créées avec les paramètres spécifiés

L'list-suite-definitionsexemple suivant répertorie les suites de tests Device Advisor que vous avez créées dans AWS l'IoT avec le nombre maximum de résultats spécifié. Si vous avez plus de suites de tests que le nombre maximum, le nextToken « » sera affiché dans la sortie. Si vous avez nextToken « », vous pouvez utiliser « nextToken » pour afficher les suites de tests que vous avez créées et qui n'étaient pas affichées auparavant.


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

Sortie :


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

Pour plus d'informations, consultez le ListSuiteDefinitionsmanuel de APIréférence sur l'AWS IoT.

Pour API plus de détails, voir ListSuiteDefinitionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-suite-runs.

AWS CLI

Exemple 1 : pour répertorier toutes les informations relatives à l'IoT Device Advisor, la suite de tests indique l'état des exécutions

L'list-suite-runsexemple suivant répertorie toutes les informations relatives à l'état d'exécution d'une suite de tests Device Advisor avec l'ID de définition de suite spécifié. Si vous avez exécuté plus de 25 suites de tests, le nextToken « » sera affiché dans la sortie. Vous pouvez utiliser ce « nextToken » pour afficher le reste des exécutions de la suite de tests.


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

Sortie :


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

Exemple 2 : Pour répertorier les informations relatives à l'IoT, Device Advisor exécute l'état avec les paramètres spécifiés

L'list-suite-runsexemple suivant répertorie les informations relatives à l'état d'exécution d'une suite de tests Device Advisor avec l'ID de définition de suite spécifié et le numéro de résultat maximal spécifié. Si vous avez plus d'exécutions de suites de tests que le nombre maximum, le nextToken « » sera affiché dans la sortie. Si vous avez nextToken « », vous pouvez utiliser « nextToken » pour afficher les exécutions de la suite de tests qui n'étaient pas affichées auparavant.


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

Sortie :


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

Pour plus d'informations, consultez le ListSuiteRunsmanuel de APIréférence sur l'AWS IoT.

Pour API plus de détails, voir ListSuiteRunsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises associées à une ressource IoT Device Advisor

L'list-tags-for-resourceexemple suivant répertorie les balises associées à une ressource Device Advisor. La ressource Device Advisor peut être un Suitedefinition-Arn ou un Suiterun-Arn.


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

Sortie :


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

Pour plus d'informations, consultez ListTagsForResourcela APIréférence AWS IoT et les types de ressources définis par AWS IoT Core Device Advisor dans la référence d'autorisation de service.

Pour API plus de détails, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-suite-run.

AWS CLI

Pour démarrer une suite de tests IoT Device Advisor, exécutez

L'start-suite-runexemple suivant répertorie les widgets disponibles dans votre AWS compte.


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

Sortie :


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

Pour plus d'informations, voir Démarrer l'exécution d'une suite de tests dans le manuel AWS IoT Core Developer Guide.

Pour API plus de détails, voir StartSuiteRunla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-suite-run.

AWS CLI

Pour arrêter une suite de tests IoT Device Advisor en cours d'exécution

L'stop-suite-runexemple suivant arrête une suite de tests Device Advisor actuellement en cours d'exécution avec l'ID de définition de suite et l'ID d'exécution de suite spécifiés.


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Arrêter l'exécution d'une suite de tests dans le manuel AWS IoT Core Developer Guide.

Pour API plus de détails, voir StopSuiteRunla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter et modifier les balises existantes d'une ressource IoT Device Advisor

L'tag-resourceexemple suivant ajoute et modifie les balises existantes d'une ressource Device Advisor avec l'ARN et les balises de ressource spécifiés. La ressource Device Advisor peut être un Suitedefinition-Arn ou un Suiterun-Arn.


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez TagResourcela APIréférence AWS IoT et les types de ressources définis par AWS IoT Core Device Advisor dans la référence d'autorisation de service.

Pour API plus de détails, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer les balises existantes d'une ressource IoT Device Advisor

L'untag-resourceexemple suivant supprime les balises existantes d'une ressource Device Advisor avec l'ARN de ressource et la clé de balise spécifiés. La ressource Device Advisor peut être un Suitedefinition-Arn ou un Suiterun-Arn.


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UntagResourcela APIréférence AWS IoT et les types de ressources définis par AWS IoT Core Device Advisor dans la référence d'autorisation de service.

Pour API plus de détails, voir UntagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-suite-definition.

AWS CLI

Exemple 1 : pour mettre à jour une suite de tests IoT Device Advisor

L'update-suite-definitionexemple suivant met à jour une suite de tests Device Advisor dans l' AWS IoT avec l'ID de définition de suite et la configuration de définition de suite spécifiés.


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

Sortie :


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

Exemple 2 : pour mettre à jour une suite de tests de qualification IoT Device Advisor

L'update-suite-definitionexemple suivant met à jour une suite de tests de qualification de Device Advisor dans l' AWS IoT avec l'ID de définition de suite et la configuration de définition de suite spécifiés.


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

Sortie :


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

Pour plus d'informations, consultez le UpdateSuiteDefinitionmanuel de APIréférence sur l'AWS IoT.

Pour API plus de détails, voir UpdateSuiteDefinitionla section Référence des AWS CLI commandes.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWS IoT Analytics

AWS IoT data