AWS IoT 1-Click Ejemplos de dispositivos 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.

AWS IoT 1-Click Ejemplos de dispositivos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de AWS Command Line Interface with AWS IoT 1-Click Devices.

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 usarloclaim-devices-by-claim-code.

AWS CLI

Para reclamar uno o más dispositivos AWS IoT 1-Click mediante un código promocional

En el siguiente claim-devices-by-claim-code ejemplo, se reivindica el dispositivo AWS IoT 1-Click especificado mediante un código promocional (en lugar de un ID de dispositivo).

aws iot1click-devices claim-devices-by-claim-code \
    --claim-code C-123EXAMPLE

Salida:

{
   "Total": 9
   "ClaimCode": "C-123EXAMPLE"
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

El siguiente ejemplo de código muestra cómo usarlodescribe-device.

AWS CLI

Para describir un dispositivo

El siguiente describe-device ejemplo describe el dispositivo especificado.

aws iot1click-devices describe-device \
    --device-id G030PM0123456789

Salida:

{
    "DeviceDescription": {
        "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789",
        "Attributes": {
            "projectRegion": "us-west-2",
            "projectName": "AnytownDumpsters",
            "placementName": "customer217",
            "deviceTemplateName": "empty-dumpster-request"
        },
        "DeviceId": "G030PM0123456789",
        "Enabled": false,
        "RemainingLife": 99.9,
        "Type": "button",
        "Tags": {}
    }
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarlofinalize-device-claim.

AWS CLI

Para finalizar una solicitud de reclamación para un dispositivo AWS IoT 1-Click utilizando un ID de dispositivo

El siguiente finalize-device-claim ejemplo finaliza una solicitud de reclamación para el dispositivo AWS IoT 1-Click especificado mediante un ID de dispositivo (en lugar de un código promocional).

aws iot1click-devices finalize-device-claim \
    --device-id G030PM0123456789

Salida:

{
    "State": "CLAIMED"
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

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

AWS CLI

Para enumerar los métodos disponibles para un dispositivo

En el siguiente get-device-methods ejemplo, se enumeran los métodos disponibles para un dispositivo.

aws iot1click-devices get-device-methods \
    --device-id G030PM0123456789

Salida:

{
    "DeviceMethods": [
        {
            "MethodName": "getDeviceHealthParameters"
        },
        {
            "MethodName": "setDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "getDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "setOnClickCallback"
        },
        {
            "MethodName": "getOnClickCallback"
        }
    ]
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarloinitiate-device-claim.

AWS CLI

Para iniciar una solicitud de reclamación para un dispositivo AWS IoT 1-Click utilizando un ID de dispositivo

En el siguiente initiate-device-claim ejemplo, se inicia una solicitud de reclamación para el dispositivo AWS IoT 1-Click especificado mediante un ID de dispositivo (en lugar de un código promocional).

aws iot1click-devices initiate-device-claim \
    --device-id G030PM0123456789

Salida:

{
    "State": "CLAIM_INITIATED"
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarloinvoke-device-method.

AWS CLI

Para invocar un método de dispositivo en un dispositivo

En el siguiente invoke-device-method ejemplo, se invoca el método especificado en un dispositivo.

aws iot1click-devices invoke-device-method \
    --cli-input-json file://invoke-device-method.json

Contenidos de invoke-device-method.json:

{
    "DeviceId": "G030PM0123456789",
    "DeviceMethod": {
        "DeviceType": "device",
        "MethodName": "getDeviceHealthParameters"
    }
}

Salida:

{
    "DeviceMethodResponse": "{\"remainingLife\": 99.8}"
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarlolist-device-events.

AWS CLI

Para enumerar los eventos de un dispositivo durante un intervalo de tiempo específico

En el siguiente list-device-events ejemplo, se enumeran los eventos del dispositivo especificado para el intervalo de tiempo especificado.

aws iot1click-devices list-device-events \
    --device-id G030PM0123456789 \
    --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z

Salida:

{
    "Events": [
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}"
        },
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}"
        }
    ]
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

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

AWS CLI

Para enumerar los dispositivos de un tipo específico

En el siguiente list-devices ejemplo, se enumeran los dispositivos de un tipo específico.

aws iot1click-devices list-devices \
    --device-type button

Este comando no genera ninguna salida.

Salida:

{
    "Devices": [
        {
            "remainingLife": 99.9,
            "attributes": {
                "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
                "type": "button",
                "deviceId": "G030PM0123456789",
                "enabled": false
            }
        }
    ]
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

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

AWS CLI

Para enumerar las etiquetas de un dispositivo

En el siguiente list-tags-for-resource ejemplo, se enumeran las etiquetas del dispositivo especificado.

aws iot1click-devices list-tags-for-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789"

Salida:

{
    "Tags": {
        "Driver Phone": "123-555-0199",
        "Driver": "Jorge Souza"
    }
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

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

AWS CLI

Para añadir etiquetas a un AWS recurso de dispositivo

En el siguiente tag-resource ejemplo, se agregan dos etiquetas al recurso especificado.

aws iot1click-devices tag-resource \
    --cli-input-json file://devices-tag-resource.json

Contenidos de devices-tag-resource.json:

{
    "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
    "Tags": {
        "Driver": "Jorge Souza",
        "Driver Phone": "123-555-0199"
    }
}

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarlounclaim-device.

AWS CLI

Para anular la reclamación (anular el registro) de un dispositivo de tu cuenta AWS

El siguiente unclaim-device ejemplo anula la reclamación (anula el registro) del dispositivo especificado de tu cuenta. AWS 

aws iot1click-devices unclaim-device \
    --device-id G030PM0123456789

Salida:

{
    "State": "UNCLAIMED"
}

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

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

AWS CLI

Para eliminar etiquetas de un AWS recurso de dispositivo

En el siguiente untag-resource ejemplo, se eliminan las etiquetas con los nombres Driver Phone y Driver del recurso de dispositivo especificado.

aws iot1click-devices untag-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \
    --tag-keys "Driver Phone" "Driver"

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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

El siguiente ejemplo de código muestra cómo usarloupdate-device-state.

AWS CLI

Para actualizar el estado ``activado`` de un dispositivo

A continuación, se update-device-state establece el estado del dispositivo especificado en. enabled

aws iot1click-devices update-device-state \
    --device-id G030PM0123456789 \
    --enabled

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de AWS IoT 1-Click con la Guía para AWS CLI desarrolladores de IoT AWS 1-Click.

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