Ejemplos de proyectos de AWS IoT 1-Click que utilizan la AWS CLI - AWS Command Line Interface
Acciones

Ejemplos de proyectos de AWS IoT 1-Click que utilizan la AWS CLI

En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando la AWS Command Line Interface con proyectos de AWS IoT 1-Click.

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.

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.

Acciones

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

AWS CLI

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

En el siguiente ejemplo de associate-device-with-placement, se asocia el dispositivo de AWS IoT 1-Click especificado con 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

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

AWS CLI

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

En el siguiente ejemplo de create-placement, 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte CreatePlacement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para crear una ubicación de AWS IoT 1-Click para cero o varias ubicaciones

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

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

Contenido 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte CreateProject en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para eliminar una ubicación de un proyecto

En el siguiente ejemplo de delete-placement, 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte DeletePlacement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para eliminar un proyecto de una cuenta de AWS

En el siguiente ejemplo de delete-project, se elimina el proyecto específico de su cuenta de AWS.

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

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte DeleteProject en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para describir una ubicación para un proyecto

En el siguiente ejemplo de describe-placement, se 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte DescribePlacement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para describir un proyecto de AWS IoT 1-Click

En el siguiente ejemplo de describe-project, se describe el proyecto de 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte DescribeProject en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para desasociar un dispositivo de una ubicación

En el siguiente ejemplo de disassociate-device-from-placement, se desasocia 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

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

AWS CLI

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

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

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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte GetDevicesInPlacement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

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

En el siguiente ejemplo de list-placements, 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener detalles de la API, consulte ListPlacements en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para enumerar todos los proyectos de AWS IoT 1-Click

En el siguiente ejemplo de list-projects, se enumeran todos los proyectos de AWS IoT 1-Click de su 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener detalles sobre la API, consulte ListProjects en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para enumerar las etiquetas de un recurso de proyecto

En el siguiente ejemplo de list-tags-for-resource, se enumeran las etiquetas del recurso de proyecto que ha 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte ListTagsForResource en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para añadir las etiquetas a un recurso de proyecto

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

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

Contenido 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para ver los detalles de la API, consulte TagResource en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para eliminar etiquetas de un recurso de proyecto

En el siguiente ejemplo de untag-resource, se elimina la etiqueta con el nombre de clave Manager 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte UntagResource en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para actualizar los pares clave-valor attributes de una ubicación

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

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

Contenido 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte UpdatePlacement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para actualizar la configuración de un proyecto

En el siguiente ejemplo de update-project, 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 Using AWS IoT 1-Click with the AWS CLI en la Guía para desarrolladores de AWS IoT 1-Click.

  • Para obtener información sobre la API, consulte UpdateProject en la Referencia de comandos de la AWS CLI.