AWS IoT 1-Click Exemplos de projetos usando AWS CLI - AWS SDKExemplos de código
Ações

Há mais AWS SDK exemplos disponíveis no GitHub repositório AWS Doc SDK Examples.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWS IoT 1-Click Exemplos de projetos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS IoT 1-Click Projects.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar associate-device-with-placement.

AWS CLI

Para associar um dispositivo de AWS IoT 1-Click a um posicionamento existente

O associate-device-with-placement exemplo a seguir associa o dispositivo IoT AWS 1-Click especificado a um posicionamento 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 não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

O código de exemplo a seguir mostra como usar create-placement.

AWS CLI

Para criar um posicionamento de AWS IoT 1-Click para um projeto

O create-placement exemplo a seguir cria um posicionamento de AWS IoT 1-Click para o projeto 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 não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte CreatePlacementna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-project.

AWS CLI

Para criar um projeto de AWS IoT 1-Click para zero ou mais colocações

O create-project exemplo a seguir cria um projeto de AWS IoT 1-Click para um posicionamento.

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

Conteúdo 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 não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte CreateProjectna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-placement.

AWS CLI

Para excluir um posicionamento de um projeto

O delete-placement exemplo a seguir exclui o posicionamento especificado de um projeto.

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte DeletePlacementna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-project.

AWS CLI

Para excluir um projeto da sua AWS conta

O delete-project exemplo a seguir exclui o projeto especificado da sua AWS conta.

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte DeleteProjectna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-placement.

AWS CLI

Para descrever uma colocação para um projeto

O describe-placement exemplo a seguir descreve um posicionamento para o projeto especificado.

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

Saída:

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

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte DescribePlacementna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-project.

AWS CLI

Para descrever um projeto de AWS IoT 1-Click

O describe-project exemplo a seguir descreve o projeto de AWS IoT 1-Click especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte DescribeProjectna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar disassociate-device-from-placement.

AWS CLI

Para desassociar um dispositivo de um posicionamento

O disassociate-device-from-placement exemplo a seguir dissocia o dispositivo especificado de um posicionamento.

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

O código de exemplo a seguir mostra como usar get-devices-in-placement.

AWS CLI

Para listar todos os dispositivos em um posicionamento contido em um projeto

O get-devices-in-placement exemplo a seguir lista todos os dispositivos em um posicionamento especificado contido no projeto especificado.

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

Saída:

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

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

O código de exemplo a seguir mostra como usar list-placements.

AWS CLI

Para listar todos os AWS posicionamentos do IoT 1-Click para um projeto

O list-placements exemplo a seguir lista todos os posicionamentos AWS do IoT 1-Click para o projeto especificado.

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

Saída:

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

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte ListPlacementsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-projects.

AWS CLI

Para listar todos os projetos AWS do IoT 1-Click

O list-projects exemplo a seguir lista todos os projetos de AWS IoT 1-Click em sua conta.

aws iot1click-projects list-projects

Saída:

{
    "projects": [
        {
            "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters",
            "projectName": "AnytownDumpsters",
            "createdDate": 1563483100,
            "updatedDate": 1563483100,
            "tags": {}
        }
    ]
}

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte ListProjectsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar as tags de um recurso do projeto

O list-tags-for-resource exemplo a seguir lista as tags do recurso de projeto especificado.

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

Saída:

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

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para adicionar tags a um recurso do projeto

O tag-resource exemplo a seguir adiciona duas tags ao recurso de projeto especificado.

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

Conteúdo de devices-tag-resource.json:

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover tags de um recurso do projeto

O untag-resource exemplo a seguir remove a tag com o nome Manager da chave do projeto especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-placement.

AWS CLI

Para atualizar os pares de valores-chave de “atributos” de um posicionamento

O update-placement exemplo a seguir atualiza os pares de valores-chave “atributos” de um posicionamento.

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

Conteúdo de update-placement.json:

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte UpdatePlacementna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-project.

AWS CLI

Para atualizar as configurações de um projeto

O update-project exemplo a seguir atualiza a descrição de um projeto.

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

Este comando não produz saída.

Para obter mais informações, consulte Como usar o AWS IoT 1-Click com AWS CLI o no Guia do desenvolvedor do IoT AWS 1-Click.

  • Para API obter detalhes, consulte UpdateProjectna Referência de AWS CLI Comandos.