Ejemplos de Device Advisor que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes AWS Command Line Interface con 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 distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Temas

Acciones

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar create-suite-definition.

AWS CLI

Ejemplo 1: creación de un conjunto de pruebas de IoT Device Advisor

En el siguiente create-suite-definition ejemplo, se 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 Create a test suite definition en la Guía para desarrolladores de AWS IoT Core.

Ejemplo 2: creación de un conjunto de pruebas de IoT Device Advisor

En el siguiente create-suite-definition ejemplo, se crea un conjunto de pruebas de calificación de Device Advisor con la versión más reciente del AWS IoT y la configuración de definición del conjunto 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 Create a test suite definition en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte CreateSuiteDefinition la sección de referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-suite-definition.

AWS CLI

Para eliminar el conjunto de pruebas de IoT Device Advisor

En el siguiente ejemplo de delete-suite-definition, 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 la referencia de la API DeleteSuiteDefinition de IoT AWS .

Para obtener más información sobre la API, consulte DeleteSuiteDefinition la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar get-endpoint.

AWS CLI

Ejemplo 1: Para obtener información sobre un punto final de IoT Device Advisor Account-level

El siguiente get-endpoint ejemplo obtiene la información sobre un punto final de Account-level prueba del asesor de dispositivos.


aws iotdeviceadvisor get-endpoint

Salida:


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

Ejemplo 2: Para obtener información sobre un punto Device-level final de IoT Device Advisor

En el siguiente ejemplo de get-endpoint, se obtiene la información sobre un punto de conexión de prueba en el 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 Get a test endpoint en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte GetEndpoint la sección de referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar get-suite-definition.

AWS CLI

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

En el siguiente ejemplo de get-suite-definition, se obtiene información sobre un conjunto de pruebas de Device 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 Get a test suite definition en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte GetSuiteDefinition la Referencia de comandos. AWS CLI

En el siguiente ejemplo de código, se muestra cómo utilizar get-suite-run-report.

AWS CLI

Para obtener información sobre un informe de ejecución del conjunto de pruebas de cualificación de IoT Device Advisor

En el siguiente ejemplo de get-suite-run-report, 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 ID de definición de conjunto y el ID 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 Get a qualification report for a successful qualification test suite run en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte la Referencia de comandos. GetSuiteRunReport AWS CLI

En el siguiente ejemplo de código, se muestra cómo utilizar get-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 ejemplo de get-suite-run, 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 Get a test suite run en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte GetSuiteRun la Referencia de comandos. AWS CLI

En el siguiente ejemplo de código, se muestra cómo utilizar list-suite-definitions.

AWS CLI

Ejemplo 1: enumeración de un conjunto de pruebas de IoT Device Advisor creadas por usted

En el siguiente list-suite-definitions ejemplo, se enumeran hasta 25 conjuntos de pruebas de asesores de dispositivos que creó en IoT. AWS Si tiene más de 25 conjuntos de pruebas, se mostrará nextToken en la salida. 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: enumeración de un conjunto de pruebas de IoT Device Advisor creadas por usted con la configuración especificada

En el siguiente list-suite-definitions ejemplo, se enumeran los conjuntos de pruebas de Device Advisor que creó en AWS IoT con el número máximo de resultados especificado. Si supera el número máximo de conjuntos de pruebas, se mostrará nextToken en la salida. Si tiene nextToken, puede usar nextToken para mostrar los conjuntos de pruebas que ha creado y que no se han mostrado 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 la referencia ListSuiteDefinitions de la API de AWS IoT.

Para obtener más información sobre la API, consulte ListSuiteDefinitions la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-suite-runs.

AWS CLI

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

En el siguiente ejemplo de list-suite-runs, 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 tiene más de 25 ejecuciones de conjuntos de pruebas, se mostrará nextToken en la salida. Puede usar este nextToken para mostrar el resto de ejecuciones de conjuntos 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: enumeración de toda la 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 ejemplo de list-suite-runs, 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 y el número máximo de resultados especificado. Si supera el número máximo de ejecuciones de conjuntos de pruebas, se mostrará nextToken en la salida. Si tiene nextToken, puede usar nextToken para mostrar las ejecuciones de conjuntos de pruebas que no se han mostrado 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 la referencia de la API ListSuiteRuns de IoT AWS .

Para obtener más información sobre la API, consulte ListSuiteRuns la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-tags-for-resource.

AWS CLI

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

En el siguiente ejemplo de list-tags-for-resource, se enumeran las etiquetas asociadas a un recurso de Device Advisor. El recurso del asesor de dispositivos puede ser a Suitedefinition-Arn o a 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 ListTagsForResource la referencia de la API de AWS IoT y los tipos de recursos definidos por AWS IoT Core Device Advisor en la referencia de autorización de servicios.

Para obtener más información sobre la API, consulte ListTagsForResource la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar start-suite-run.

AWS CLI

Para iniciar una ejecución de conjunto de pruebas de IoT Device Advisor

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


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 Start a test suite run en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulta StartSuiteRun la sección de referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar stop-suite-run.

AWS CLI

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

En el siguiente ejemplo de stop-suite-run, se detiene un conjunto de pruebas de Device Advisor que se ejecuta 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 Stop a test suite run en la Guía para desarrolladores de AWS IoT Core.

Para obtener más información sobre la API, consulte StopSuiteRun la Referencia de comandos. AWS CLI

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

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

El siguiente ejemplo de tag-resource, se agregan y modifican 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 a Suitedefinition-Arn o a 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 TagResource la referencia de la API de AWS IoT y los tipos de recursos definidos por AWS IoT Core Device Advisor en la referencia de autorización de servicios.

Para obtener más información sobre la API, consulte TagResource la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

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

El siguiente ejemplo de untag-resource, 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 a Suitedefinition-Arn o a 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 UntagResource la referencia de la API de AWS IoT y los tipos de recursos definidos por AWS IoT Core Device Advisor en la referencia de autorización de servicios.

Para obtener más información sobre la API, consulte UntagResource la Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar update-suite-definition.

AWS CLI

Ejemplo 1: actualización de 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: actualización de un conjunto de pruebas de IoT Device Advisor

En el siguiente update-suite-definition ejemplo, se actualiza un conjunto de pruebas de calificación de Device Advisor en el AWS IoT con el ID de definición de conjunto 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 UpdateSuiteDefinition la referencia de la API de AWS IoT.

Para obtener más información sobre la API, consulte UpdateSuiteDefinition la Referencia de AWS CLI comandos.

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

AWS IoT

AWS IoT data