Ejemplos de Device Advisor que utilizan AWS CLI - AWS Command Line Interface
Acciones

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Device Advisor que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el AWS Command Line Interface uso de Device Advisor.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

El siguiente ejemplo de código muestra cómo usarlocreate-suite-definition.

AWS CLI

Ejemplo 1: Para crear un conjunto de pruebas de IoT Device Advisor

El siguiente create-suite-definition ejemplo crea un conjunto de pruebas de Device Advisor en el AWS IoT con la configuración de definición de conjunto especificada.

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

Salida:

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

Para obtener más información, consulte Crear una definición de conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

Ejemplo 2: Para crear un conjunto de pruebas de calificación más reciente de IoT Device Advisor

El siguiente create-suite-definition ejemplo crea un conjunto de pruebas de calificación de Device Advisor con la última versión del AWS IoT con la configuración de definición de suite especificada.

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

Salida:

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

Para obtener más información, consulte Crear una definición de conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

El siguiente ejemplo de código muestra cómo usarlodelete-suite-definition.

AWS CLI

Para eliminar el conjunto de pruebas de IoT Device Advisor

En el siguiente delete-suite-definition ejemplo, se elimina el conjunto de pruebas de Device Advisor con el ID de definición de conjunto especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteSuiteDefinitionla APIReferencia de AWS IoT.

El siguiente ejemplo de código muestra cómo usarloget-endpoint.

AWS CLI

Ejemplo 1: Para obtener la información sobre un punto final a nivel de cuenta de IoT Device Advisor

En el siguiente get-endpoint ejemplo, se obtiene la información sobre un terminal de prueba a nivel de cuenta de Device Advisor.

aws iotdeviceadvisor get-endpoint

Salida:

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

Ejemplo 2: Para obtener la información sobre un punto final a nivel de dispositivo de IoT Device Advisor

En el siguiente get-endpoint ejemplo, se obtiene la información sobre un punto final de prueba a nivel de dispositivo de Device Advisor con el thing-arn o el certificate-arn especificados.

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

Salida:

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

Para obtener más información, consulte Obtenga un punto final de prueba en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte GetEndpointla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-suite-definition.

AWS CLI

Para obtener información sobre un conjunto de pruebas de IoT Device Advisor

En el siguiente get-suite-definition ejemplo, se obtiene la información sobre un conjunto de pruebas de aevice Advisor con el ID de definición de conjunto especificado.

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

Salida:

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

Para obtener más información, consulte Obtener una definición de conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte GetSuiteDefinitionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-suite-run-report.

AWS CLI

Para obtener información sobre un informe de ejecución de un conjunto de pruebas apto para IoT Device Advisor

En el siguiente get-suite-run-report ejemplo, se obtiene el enlace de descarga del informe correspondiente a un conjunto de pruebas que cumpla los requisitos de Device Advisor y que se ejecute correctamente con el identificador de definición de conjunto y el identificador de ejecución de conjunto especificados.

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

Salida:

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

Para obtener más información, consulte Obtenga un informe de calificación para ejecutar con éxito un conjunto de pruebas de calificación en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte GetSuiteRunReportla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-suite-run.

AWS CLI

Para obtener información sobre el estado de ejecución de un conjunto de pruebas de IoT Device Advisor

En el siguiente get-suite-run ejemplo, se obtiene la información sobre el estado de ejecución de un conjunto de pruebas de Device Advisor con el ID de definición de conjunto y el ID de ejecución de conjunto especificados.

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

Salida:

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

Para obtener más información, consulte Ejecutar un conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte GetSuiteRunla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-suite-definitions.

AWS CLI

Ejemplo 1: Para enumerar los conjuntos de pruebas de IoT Device Advisor que ha creado

En el siguiente list-suite-definitions ejemplo, se enumeran hasta 25 conjuntos de pruebas de Device Advisor que creó en el AWS IoT. Si tiene más de 25 conjuntos de pruebas, se mostrará el símbolo nextToken "» en el resultado. Puede usar este "nextToken" para mostrar el resto de los conjuntos de pruebas que ha creado.

aws iotdeviceadvisor list-suite-definitions

Salida:

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

Ejemplo 2: Para enumerar los conjuntos de pruebas de IoT Device Advisor que creó con la configuración especificada

En el siguiente list-suite-definitions ejemplo, se enumeran los conjuntos de pruebas de Device Advisor que creó en el AWS IoT con el número máximo de resultados especificado. Si tiene más conjuntos de pruebas que el número máximo, en el resultado se mostrará el símbolo nextToken «». Si tiene "nextToken«, puede usar" nextToken "para mostrar los conjuntos de pruebas que creó y que no se mostraban antes.

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

Salida:

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

Para obtener más información, consulte ListSuiteDefinitionsla APIReferencia de AWS IoT.

  • Para API obtener más información, consulte ListSuiteDefinitionsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-suite-runs.

AWS CLI

Ejemplo 1: Para enumerar toda la información sobre el estado de ejecución del conjunto de pruebas de IoT Device Advisor especificado

En el siguiente list-suite-runs ejemplo, se muestra toda la información sobre el estado de ejecución de un conjunto de pruebas de Device Advisor con el ID de definición de conjunto especificado. Si ha ejecutado más de 25 conjuntos de pruebas, en el resultado se mostrará el símbolo nextToken "». Puede usar este "nextToken" para mostrar el resto de las ejecuciones del conjunto de pruebas.

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

Salida:

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

Ejemplo 2: Para mostrar información sobre el estado de ejecución del conjunto de pruebas de IoT Device Advisor especificado con la configuración especificada

En el siguiente list-suite-runs ejemplo, se muestra información sobre el estado de ejecución de un conjunto de pruebas de Device Advisor con el ID de definición del conjunto especificado y el número máximo de resultado especificado. Si tiene más ejecuciones de conjuntos de pruebas que el número máximo, en el resultado se mostrará el símbolo nextToken «». Si tiene "nextToken«, puede usar" nextToken "para mostrar las ejecuciones del conjunto de pruebas que no se mostraron antes.

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

Salida:

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

Para obtener más información, consulte ListSuiteRunsla APIReferencia de AWS IoT.

  • Para API obtener más información, consulte ListSuiteRunsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-tags-for-resource.

AWS CLI

Para enumerar las etiquetas adjuntas a un recurso de IoT Device Advisor

En el siguiente list-tags-for-resource ejemplo, se enumeran las etiquetas adjuntas a un recurso de Device Advisor. El recurso del asesor de dispositivos puede ser un Suitedefinition-Arn o un Suiterun-Arn.

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

Salida:

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

Para obtener más información, consulte ListTagsForResourcelos tipos de APIreferencia y recursos de AWS IoT definidos por AWS IoT Core Device Advisor en la Referencia de autorización de servicios.

  • Para API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlostart-suite-run.

AWS CLI

Para iniciar un conjunto de pruebas de IoT Device Advisor, ejecute

El siguiente start-suite-run ejemplo muestra los widgets disponibles en su AWS cuenta.

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

Salida:

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

Para obtener más información, consulte Iniciar la ejecución de un conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte StartSuiteRunla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlostop-suite-run.

AWS CLI

Para detener un conjunto de pruebas de IoT Device Advisor que se está ejecutando actualmente

El siguiente stop-suite-run ejemplo detiene un conjunto de pruebas de Device Advisor que se está ejecutando actualmente con el ID de definición de conjunto y el ID de ejecución de conjunto especificados.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Detener la ejecución de un conjunto de pruebas en la Guía para desarrolladores de AWS IoT Core.

  • Para API obtener más información, consulte StopSuiteRunla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlotag-resource.

AWS CLI

Para agregar y modificar las etiquetas existentes de un recurso de IoT Device Advisor

El siguiente tag-resource ejemplo agrega y modifica las etiquetas existentes de un recurso de Device Advisor con el arn y las etiquetas del recurso especificados. El recurso del asesor de dispositivos puede ser un Suitedefinition-Arn o un Suiterun-Arn.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte TagResourcelos tipos de APIreferencia y recursos de AWS IoT definidos por AWS IoT Core Device Advisor en la Referencia de autorización de servicios.

  • Para API obtener más información, consulte TagResourcela Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlountag-resource.

AWS CLI

Para eliminar las etiquetas existentes de un recurso de IoT Device Advisor

En el siguiente untag-resource ejemplo, se eliminan las etiquetas existentes de un recurso de Device Advisor con el arn y la clave de etiqueta del recurso especificados. El recurso del asesor de dispositivos puede ser 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"

Este comando no genera ninguna salida.

Para obtener más información, consulte UntagResourcelos tipos de APIreferencia y recursos de AWS IoT definidos por AWS IoT Core Device Advisor en la Referencia de autorización de servicios.

  • Para API obtener más información, consulte UntagResourcela Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-suite-definition.

AWS CLI

Ejemplo 1: Para actualizar un conjunto de pruebas de IoT Device Advisor

El siguiente update-suite-definition ejemplo actualiza un conjunto de pruebas de Device Advisor en el AWS IoT con el ID de definición de suite y la configuración de definición de suite especificados.

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

Salida:

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

Ejemplo 2: Para actualizar un conjunto de pruebas de calificación de IoT Device Advisor

El siguiente update-suite-definition ejemplo actualiza un conjunto de pruebas de calificación de Device Advisor en el AWS IoT con el ID de definición de suite y la configuración de definición de suite especificados.

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

Salida:

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

Para obtener más información, consulte UpdateSuiteDefinitionla APIReferencia de AWS IoT.