AWS IoT 1-Click Ejemplos de proyectos utilizando AWS CLI - AWS SDKEjemplos de código
Acciones

Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de AWS Doc SDK Examples.

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 proyectos utilizando AWS CLI

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

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

En el siguiente ejemplo de código se muestra cómo usar associate-device-with-placement.

AWS CLI

Para asociar un dispositivo AWS IoT 1-Click a una ubicación existente

El siguiente associate-device-with-placement ejemplo asocia el dispositivo AWS IoT 1-Click especificado a una ubicación existente.

aws iot1click-projects associate-device-with-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217 \
    --device-template-name empty-dumpster-request \
    --device-id G030PM0123456789

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.

En el siguiente ejemplo de código se muestra cómo usar create-placement.

AWS CLI

Para crear una ubicación de AWS IoT en 1-Click para un proyecto

En el siguiente create-placement ejemplo, se crea una ubicación de AWS IoT 1-Click para el proyecto especificado.

aws iot1click-projects create-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217 \
    --attributes "{"location": "123 Any Street Anytown, USA 10001", "phone": "123-456-7890"}"

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 CreatePlacementde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-project.

AWS CLI

Para crear un proyecto de 1-Click de AWS IoT para cero o más ubicaciones

En el siguiente create-project ejemplo, se crea un proyecto de 1-Click de AWS IoT para una ubicación.

as iot1click-projects create-project: file: //create-project.json cli-input-json

Contenidos de create-project.json:

{
     "projectName": "AnytownDumpsters",
     "description": "All dumpsters in the Anytown region.",
     "placementTemplate": {
         "defaultAttributes": {
             "City" : "Anytown"
         },
         "deviceTemplates": {
             "empty-dumpster-request" : {
                 "deviceType": "button"
             }
         }
     }
}

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 CreateProjectde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-placement.

AWS CLI

Para eliminar una ubicación de un proyecto

En el siguiente delete-placement ejemplo, se elimina la ubicación especificada de un proyecto.

aws iot1click-projects delete-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217

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 DeletePlacementde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-project.

AWS CLI

Para eliminar un proyecto de tu AWS cuenta

En el siguiente delete-project ejemplo, se elimina el proyecto especificado de tu AWS cuenta.

aws iot1click-projects delete-project \
    --project-name AnytownDumpsters

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 DeleteProjectde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-placement.

AWS CLI

Para describir la ubicación de un proyecto

El siguiente describe-placement ejemplo describe una ubicación para el proyecto especificado.

aws iot1click-projects describe-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217

Salida:

{
    "placement": {
        "projectName": "AnytownDumpsters",
        "placementName": "customer217",
        "attributes": {
            "phone": "123-555-0110",
            "location": "123 Any Street Anytown, USA 10001"
        },
        "createdDate": 1563488454,
        "updatedDate": 1563488454
    }
}

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 DescribePlacementde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-project.

AWS CLI

Para describir un proyecto de AWS IoT 1-Click

El siguiente describe-project ejemplo describe el proyecto AWS IoT 1-Click especificado.

aws iot1click-projects describe-project \
    --project-name AnytownDumpsters

Salida:

{
    "project": {
        "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters",
        "projectName": "AnytownDumpsters",
        "description": "All dumpsters in the Anytown region.",
        "createdDate": 1563483100,
        "updatedDate": 1563483100,
        "placementTemplate": {
            "defaultAttributes": {
                "City": "Anytown"
            },
            "deviceTemplates": {
                "empty-dumpster-request": {
                    "deviceType": "button",
                    "callbackOverrides": {}
                }
            }
        },
        "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 DescribeProjectde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar disassociate-device-from-placement.

AWS CLI

Para desasociar un dispositivo de una ubicación

El siguiente disassociate-device-from-placement ejemplo disocia el dispositivo especificado de una ubicación.

aws iot1click-projects disassociate-device-from-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217 \
    --device-template-name empty-dumpster-request

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.

En el siguiente ejemplo de código se muestra cómo usar get-devices-in-placement.

AWS CLI

Para enumerar todos los dispositivos de una ubicación incluida en un proyecto

En el siguiente get-devices-in-placement ejemplo, se enumeran todos los dispositivos en la ubicación especificada incluida en el proyecto especificado.

aws iot1click-projects get-devices-in-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217

Salida:

{
    "devices": {
        "empty-dumpster-request": "G030PM0123456789"
    }
}

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.

En el siguiente ejemplo de código se muestra cómo usar list-placements.

AWS CLI

Para enumerar todas las ubicaciones de AWS IoT 1-Click de un proyecto

En el siguiente list-placements ejemplo, se enumeran todas las ubicaciones de AWS IoT 1-Click para el proyecto especificado.

aws iot1click-projects list-placements \
    --project-name AnytownDumpsters

Salida:

{
    "placements": [
        {
            "projectName": "AnytownDumpsters",
            "placementName": "customer217",
            "createdDate": 1563488454,
            "updatedDate": 1563488454
        }
    ]
}

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 ListPlacementsde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-projects.

AWS CLI

Para enumerar todos los proyectos AWS de IoT 1-Click

En el siguiente list-projects ejemplo, se enumeran todos los proyectos de AWS IoT 1-Click de tu cuenta.

aws iot1click-projects list-projects

Salida:

{
    "projects": [
        {
            "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters",
            "projectName": "AnytownDumpsters",
            "createdDate": 1563483100,
            "updatedDate": 1563483100,
            "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 ListProjectsde AWS CLI comandos.

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

AWS CLI

Para enumerar las etiquetas de un recurso de proyecto

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

aws iot1click-projects list-tags-for-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters"

Salida:

{
    "tags": {
        "Manager": "Li Juan",
        "Account": "45215"
    }
}

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.

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

AWS CLI

Para añadir etiquetas a un recurso de proyecto

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

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

Contenidos de devices-tag-resource.json:

{
    "resourceArn": "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters",
    "tags": {
        "Account": "45215",
        "Manager": "Li Juan"
    }
}

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.

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

AWS CLI

Para eliminar etiquetas de un recurso del proyecto

En el siguiente untag-resource ejemplo, se elimina la etiqueta con el nombre Manager de clave del proyecto especificado.

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

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.

En el siguiente ejemplo de código se muestra cómo usar update-placement.

AWS CLI

Para actualizar los pares clave-valor de los «atributos» de una ubicación

En el siguiente update-placement ejemplo, se actualizan los pares clave-valor de «atributos» de una ubicación.

aws iot1click-projects update-placement \
    --cli-input-json file://update-placement.json

Contenidos de update-placement.json:

{
    "projectName": "AnytownDumpsters",
    "placementName": "customer217",
    "attributes": {
        "phone": "123-456-7890",
        "location": "123 Any Street Anytown, USA 10001"
    }
}

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 UpdatePlacementde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar update-project.

AWS CLI

Para actualizar la configuración de un proyecto

En el siguiente update-project ejemplo, se actualiza la descripción de un proyecto.

aws iot1click-projects update-project \
    --project-name AnytownDumpsters \
    --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region."

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 UpdateProjectde AWS CLI comandos.