AWS IoT Greengrass V2 exemplos usando AWS CLI - AWS SDKExemplos de código

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 Greengrass V2 exemplos 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 Greengrass V2.

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-service-role-to-account.

AWS CLI

Para associar a função de serviço do Greengrass à sua conta AWS

O associate-service-role-to-account exemplo a seguir associa uma função de serviço ao AWS IoT AWS Greengrass para sua conta.

aws greengrassv2 associate-service-role-to-account \ --role-arn arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole

Saída:

{ "associatedAt": "2022-01-19T19:21:53Z" }

Para obter mais informações, consulte a função de serviço do Greengrass no Guia do desenvolvedor do IoT AWS Greengrass V2.

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

AWS CLI

Para associar dispositivos cliente a um dispositivo principal

O batch-associate-client-device-with-core-device exemplo a seguir associa dois dispositivos cliente a um dispositivo principal.

aws greengrassv2 batch-associate-client-device-with-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2

Saída:

{ "errorEntries": [] }

Para obter mais informações, consulte Interaja com dispositivos de IoT locais no Guia do desenvolvedor do IoT AWS Greengrass V2.

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

AWS CLI

Para dissociar dispositivos cliente de um dispositivo principal

O batch-disassociate-client-device-from-core-device exemplo a seguir dissocia dois dispositivos cliente de um dispositivo principal.

aws greengrassv2 batch-disassociate-client-device-from-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2

Saída:

{ "errorEntries": [] }

Para obter mais informações, consulte Interaja com dispositivos de IoT locais no Guia do desenvolvedor do IoT AWS Greengrass V2.

O código de exemplo a seguir mostra como usar cancel-deployment.

AWS CLI

Para cancelar uma implantação

O cancel-deployment exemplo a seguir interrompe uma implantação contínua em um grupo de coisas.

aws greengrassv2 cancel-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{ "message": "SUCCESS" }

Para obter mais informações, consulte Cancelar implantações no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Exemplo 1: Para criar uma versão de componente a partir de uma receita

O create-component-version exemplo a seguir cria uma versão de um componente Hello World a partir de um arquivo de receita.

aws greengrassv2 create-component-version \ --inline-recipe fileb://com.example.HelloWorld-1.0.0.json

Conteúdo de com.example.HelloWorld-1.0.0.json:

{ "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.HelloWorld", "ComponentVersion": "1.0.0", "ComponentDescription": "My first AWS IoT Greengrass component.", "ComponentPublisher": "Amazon", "ComponentConfiguration": { "DefaultConfiguration": { "Message": "world" } }, "Manifests": [ { "Platform": { "os": "linux" }, "Lifecycle": { "Run": "echo 'Hello {configuration:/Message}'" } } ] }

Saída:

{ "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T16:24:33.650000-08:00", "status": { "componentState": "REQUESTED", "message": "NONE", "errors": {} } }

Para obter mais informações, consulte Criar componentes personalizados e Carregar componentes para implantação no Guia do desenvolvedor do AWS IoT Greengrass V2.

Exemplo 2: Para criar uma versão de componente a partir de uma função AWS Lambda

O create-component-version exemplo a seguir cria uma versão de um componente Hello World a partir de uma função AWS Lambda.

aws greengrassv2 create-component-version \ --cli-input-json file://lambda-function-component.json

Conteúdo de lambda-function-component.json:

{ "lambdaFunction": { "lambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:HelloWorldPythonLambda:1", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ] } } }

Saída:

{ "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T17:05:27.347000-08:00", "status": { "componentState": "REQUESTED", "message": "NONE", "errors": {} } }

Para obter mais informações, consulte Executar funções do AWS Lambda no Guia do desenvolvedor do IoT AWS Greengrass V2.

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

AWS CLI

Exemplo 1: Para criar uma implantação

O create-deployment exemplo a seguir implanta a interface de linha de comando do AWS IoT Greengrass em um dispositivo principal.

aws greengrassv2 create-deployment \ --cli-input-json file://cli-deployment.json

Conteúdo de cli-deployment.json:

{ "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "deploymentName": "Deployment for MyGreengrassCore", "components": { "aws.greengrass.Cli": { "componentVersion": "2.0.3" } }, "deploymentPolicies": { "failureHandlingPolicy": "DO_NOTHING", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {} }

Saída:

{ "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }

Para obter mais informações, consulte Criar implantações no Guia do desenvolvedor do AWS IoT Greengrass V2.

Exemplo 2: Para criar uma implantação que atualize as configurações dos componentes

O create-deployment exemplo a seguir implanta o componente nuclear do AWS IoT Greengrass em um grupo de dispositivos principais. Essa implantação aplica as seguintes atualizações de configuração para o componente do núcleo:

Redefina as configurações de proxy dos dispositivos de destino para as configurações padrão sem proxy. Redefina as MQTT configurações dos dispositivos de destino para seus padrões.Define as JVM opções para o núcleo. Define o nível de registro do núcleo. JVM

aws greengrassv2 create-deployment \ --cli-input-json file://nucleus-deployment.json

Conteúdo de nucleus-deployment.json:

{ "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "deploymentName": "Deployment for MyGreengrassCoreGroup", "components": { "aws.greengrass.Nucleus": { "componentVersion": "2.0.3", "configurationUpdate": { "reset": [ "/networkProxy", "/mqtt" ], "merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}" } } }, "deploymentPolicies": { "failureHandlingPolicy": "ROLLBACK", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {} }

Saída:

{ "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }

Para obter mais informações, consulte Criar implantações e atualizar configurações de componentes no Guia do desenvolvedor do IoT AWS Greengrass V2.

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

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

AWS CLI

Para excluir uma versão do componente

O delete-component exemplo a seguir exclui um componente Hello World.

aws greengrassv2 delete-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Para excluir um dispositivo principal

O delete-core-device exemplo a seguir exclui um dispositivo principal do AWS IoT Greengrass.

aws greengrassv2 delete-core-device \ --core-device-thing-name MyGreengrassCore

Este comando não produz saída.

Para obter mais informações, consulte Desinstalar o software AWS IoT Greengrass Core no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Para descrever a versão de um componente

O describe-component exemplo a seguir descreve um componente Hello World.

aws greengrassv2 describe-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0

Saída:

{ "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T17:12:11.133000-08:00", "publisher": "Amazon", "description": "My first AWS IoT Greengrass component.", "status": { "componentState": "DEPLOYABLE", "message": "NONE", "errors": {} }, "platforms": [ { "attributes": { "os": "linux" } } ] }

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

O código de exemplo a seguir mostra como usar disassociate-service-role-from-account.

AWS CLI

Para desassociar a função de serviço do Greengrass da sua conta AWS

O disassociate-service-role-from-account exemplo a seguir dissocia a função de serviço do Greengrass do AWS IoT Greengrass para sua conta. AWS

aws greengrassv2 disassociate-service-role-from-account

Saída:

{ "disassociatedAt": "2022-01-19T19:26:09Z" }

Para obter mais informações, consulte a função de serviço do Greengrass no Guia do desenvolvedor do IoT AWS Greengrass V2.

O código de exemplo a seguir mostra como usar get-component-version-artifact.

AWS CLI

Para obter um URL para baixar um artefato de componente

O get-component-version-artifact exemplo a seguir obtém um URL para baixar o JAR arquivo do componente do console de depuração local.

aws greengrassv2 get-component-version-artifact \ --arn arn:aws:greengrass:us-west-2:aws:components:aws.greengrass.LocalDebugConsole:versions:2.0.3 \ --artifact-name "Uvt6ZEzQ9TKiAuLbfXBX_APdY0TWks3uc46tHFHTzBM=/aws.greengrass.LocalDebugConsole.jar"

Saída:

{ "preSignedUrl": "https://evergreencomponentmanageme-artifactbucket7410c9ef-g18n1iya8kwr.s3.us-west-2.amazonaws.com/public/aws.greengrass.LocalDebugConsole/2.0.3/s3/ggv2-component-releases-prod-pdx/EvergreenHttpDebugView/2ffc496ba41b39568968b22c582b4714a937193ee7687a45527238e696672521/aws.greengrass.LocalDebugConsole/aws.greengrass.LocalDebugConsole.jar?X-Amz-Security-Token=KwfLKSdEXAMPLE..." }

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

O código de exemplo a seguir mostra como usar get-component.

AWS CLI

Exemplo 1: Para baixar a receita de um componente em YAML formato (Linux, macOS ou Unix)

O get-component exemplo a seguir baixa a receita de um componente Hello World em um arquivo em YAML formato. Esse comando faz o seguinte:

Usa os --query parâmetros --output e para controlar a saída do comando. Esses parâmetros extraem o blob da receita da saída do comando. Para obter mais informações sobre como controlar a saída, consulte Controlando a saída do comando no Guia do usuário da interface de linha de AWS comando. Usa o base64 utilitário. Esse utilitário decodifica o blob extraído para o texto original. O blob retornado por um get-component comando bem-sucedido é um texto codificado em base64. Você deve decodificar esse blob para obter o texto original. Salva o texto decodificado em um arquivo. A seção final do comando (> com.example.HelloWorld-1.0.0.json) salva o texto decodificado em um arquivo.

aws greengrassv2 get-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 \ --recipe-output-format YAML \ --query recipe \ --output text | base64 --decode > com.example.HelloWorld-1.0.0.json

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

Exemplo 2: Para baixar a receita de um componente em YAML formato (WindowsCMD)

O get-component exemplo a seguir baixa a receita de um componente Hello World em um arquivo em YAML formato. Esse comando usa o certutil utilitário.

aws greengrassv2 get-component ^ --arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 ^ --recipe-output-format YAML ^ --query recipe ^ --output text > com.example.HelloWorld-1.0.0.yaml.b64 certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

Exemplo 3: Para baixar a receita de um componente em YAML formato (Windows PowerShell)

O get-component exemplo a seguir baixa a receita de um componente Hello World em um arquivo em YAML formato. Esse comando usa o certutil utilitário.

aws greengrassv2 get-component ` --arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 ` --recipe-output-format YAML ` --query recipe ` --output text > com.example.HelloWorld-1.0.0.yaml.b64 certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

O código de exemplo a seguir mostra como usar get-connectivity-info.

AWS CLI

Para obter as informações de conectividade de um dispositivo principal do Greengrass

O get-connectivity-info exemplo a seguir obtém as informações de conectividade de um dispositivo principal do Greengrass. Os dispositivos cliente usam essas informações para se conectar ao MQTT agente que é executado nesse dispositivo principal.

aws greengrassv2 get-connectivity-info \ --thing-name MyGreengrassCore

Saída:

{ "connectivityInfo": [ { "id": "localIP_192.0.2.0", "hostAddress": "192.0.2.0", "portNumber": 8883 } ] }

Para obter mais informações, consulte Gerenciar endpoints de dispositivos principais no Guia do desenvolvedor do AWS IoT Greengrass V2.

O código de exemplo a seguir mostra como usar get-core-device.

AWS CLI

Para obter um dispositivo principal

O get-core-device exemplo a seguir obtém informações sobre um dispositivo principal AWS do IoT Greengrass.

aws greengrassv2 get-core-device \ --core-device-thing-name MyGreengrassCore

Saída:

{ "coreDeviceThingName": "MyGreengrassCore", "coreVersion": "2.0.3", "platform": "linux", "architecture": "amd64", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00", "tags": {} }

Para obter mais informações, consulte Verificar o status do dispositivo principal no Guia do AWS desenvolvedor do IoT Greengrass V2.

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

O código de exemplo a seguir mostra como usar get-deployment.

AWS CLI

Para obter uma implantação

O get-deployment exemplo a seguir obtém informações sobre a implantação do componente do núcleo AWS IoT Greengrass em um grupo de dispositivos principais.

aws greengrassv2 get-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{ "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "revisionId": "14", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCoreGroup", "deploymentStatus": "ACTIVE", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "components": { "aws.greengrass.Nucleus": { "componentVersion": "2.0.3", "configurationUpdate": { "merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}", "reset": [ "/networkProxy", "/mqtt" ] } } }, "deploymentPolicies": { "failureHandlingPolicy": "ROLLBACK", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {}, "creationTimestamp": "2021-01-07T17:21:20.691000-08:00", "isLatestForTarget": false, "tags": {} }

Para obter mais informações, consulte Implantar componentes em dispositivos no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

O código de exemplo a seguir mostra como usar get-service-role-for-account.

AWS CLI

Para obter a função de serviço do Greengrass em sua conta AWS

O get-service-role-for-account exemplo a seguir obtém a função de serviço associada ao AWS IoT Greengrass para sua conta. AWS

aws greengrassv2 get-service-role-for-account

Saída:

{ "associatedAt": "2022-01-19T19:21:53Z", "roleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" }

Para obter mais informações, consulte a função de serviço do Greengrass no Guia do desenvolvedor do IoT AWS Greengrass V2.

O código de exemplo a seguir mostra como usar list-client-devices-associated-with-core-device.

AWS CLI

Para listar os dispositivos cliente associados a um dispositivo principal

O list-client-devices-associated-with-core-device exemplo a seguir lista todos os dispositivos cliente associados a um dispositivo principal.

aws greengrassv2 list-client-devices-associated-with-core-device \ --core-device-thing-name MyTestGreengrassCore

Saída:

{ "associatedClientDevices": [ { "thingName": "MyClientDevice2", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" }, { "thingName": "MyClientDevice1", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" } ] }

Para obter mais informações, consulte Interaja com dispositivos de IoT locais no Guia do desenvolvedor do IoT AWS Greengrass V2.

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

AWS CLI

Para listar as versões de um componente

O list-component-versions exemplo a seguir lista todas as versões de um componente Hello World.

aws greengrassv2 list-component-versions \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld

Saída:

{ "componentVersions": [ { "componentName": "com.example.HelloWorld", "componentVersion": "1.0.1", "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1" }, { "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0" } ] }

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

AWS CLI

Para listar componentes

O list-components exemplo a seguir lista cada componente e sua versão mais recente definida em sua AWS conta na região atual.

aws greengrassv2 list-components

Saída:

{ "components": [ { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld", "componentName": "com.example.HelloWorld", "latestVersion": { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1", "componentVersion": "1.0.1", "creationTimestamp": "2021-01-08T16:51:07.352000-08:00", "description": "My first AWS IoT Greengrass component.", "publisher": "Amazon", "platforms": [ { "attributes": { "os": "linux" } } ] } } ] }

Para obter mais informações, consulte Gerenciar componentes no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Para listar os dispositivos principais

O list-core-devices exemplo a seguir lista os principais dispositivos do AWS IoT Greengrass em sua AWS conta na região atual.

aws greengrassv2 list-core-devices

Saída:

{ "coreDevices": [ { "coreDeviceThingName": "MyGreengrassCore", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00" } ] }

Para obter mais informações, consulte Verificar o status do dispositivo principal no Guia do AWS desenvolvedor do IoT Greengrass V2.

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

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

AWS CLI

Para listar implantações

O list-deployments exemplo a seguir lista a revisão mais recente de cada implantação definida em sua AWS conta na região atual.

aws greengrassv2 list-deployments

Saída:

{ "deployments": [ { "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "revisionId": "14", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCoreGroup", "creationTimestamp": "2021-01-07T17:21:20.691000-08:00", "deploymentStatus": "ACTIVE", "isLatestForTarget": false }, { "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "revisionId": "1", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "deploymentName": "Deployment for MyGreengrassCore", "creationTimestamp": "2021-01-06T16:10:42.407000-08:00", "deploymentStatus": "COMPLETED", "isLatestForTarget": false } ] }

Para obter mais informações, consulte Implantar componentes em dispositivos no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Para listar trabalhos de implantação

O list-effective-deployments exemplo a seguir lista as implantações que se aplicam a um dispositivo principal do AWS IoT Greengrass.

aws greengrassv2 list-effective-deployments \ --core-device-thing-name MyGreengrassCore

Saída:

{ "effectiveDeployments": [ { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCore", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "coreDeviceExecutionStatus": "COMPLETED", "reason": "SUCCESSFUL", "creationTimestamp": "2021-01-06T16:10:42.442000-08:00", "modifiedTimestamp": "2021-01-08T17:21:27.830000-08:00" }, { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "deploymentName": "Deployment for MyGreengrassCoreGroup", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "coreDeviceExecutionStatus": "SUCCEEDED", "reason": "SUCCESSFUL", "creationTimestamp": "2021-01-07T17:19:20.394000-08:00", "modifiedTimestamp": "2021-01-07T17:21:20.721000-08:00" } ] }

Para obter mais informações, consulte Verificar o status do dispositivo principal no Guia do AWS desenvolvedor do IoT Greengrass V2.

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

AWS CLI

Para listar os componentes instalados em um dispositivo principal

O list-installed-components exemplo a seguir lista os componentes que estão instalados em um dispositivo principal AWS do IoT Greengrass.

aws greengrassv2 list-installed-components \ --core-device-thing-name MyGreengrassCore

Saída:

{ "installedComponents": [ { "componentName": "aws.greengrass.Cli", "componentVersion": "2.0.3", "lifecycleState": "RUNNING", "isRoot": true }, { "componentName": "aws.greengrass.Nucleus", "componentVersion": "2.0.3", "lifecycleState": "FINISHED", "isRoot": true } ] }

Para obter mais informações, consulte Verificar o status do dispositivo principal no Guia do AWS desenvolvedor do IoT Greengrass V2.

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

AWS CLI

Para listar as tags de um recurso

O list-tags-for-resource exemplo a seguir lista todas as tags de um dispositivo AWS principal do IoT Greengrass.

aws greengrassv2 list-tags-for-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore

Saída:

{ "tags": { "Owner": "richard-roe" } }

Para obter mais informações, consulte Marcar seus recursos no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

AWS CLI

Para adicionar uma tag a um recurso

O tag-resource exemplo a seguir adiciona uma tag de proprietário a um dispositivo AWS principal do IoT Greengrass. Você pode usar essa tag para controlar o acesso ao dispositivo principal com base em quem o possui.

aws greengrassv2 tag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tags Owner=richard-roe

Este comando não produz saída.

Para obter mais informações, consulte Marcar seus recursos no Guia do desenvolvedor do AWS IoT Greengrass V2.

  • 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 uma tag de um recurso

O untag-resource exemplo a seguir remove uma tag de proprietário de um dispositivo AWS principal do IoT Greengrass.

aws iotsitewise untag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tag-keys Owner

Este comando não produz saída.

Para obter mais informações, consulte Marcar seus recursos no Guia do desenvolvedor do AWS IoT Greengrass V2.

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

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

AWS CLI

Para atualizar as informações de conectividade de um dispositivo principal do Greengrass

O update-connectivity-info exemplo a seguir obtém as informações de conectividade de um dispositivo principal do Greengrass. Os dispositivos cliente usam essas informações para se conectar ao MQTT agente que é executado nesse dispositivo principal.

aws greengrassv2 update-connectivity-info \ --thing-name MyGreengrassCore \ --cli-input-json file://core-device-connectivity-info.json

Conteúdo de core-device-connectivity-info.json:

{ "connectivityInfo": [ { "hostAddress": "192.0.2.0", "portNumber": 8883, "id": "localIP_192.0.2.0" } ] }

Saída:

{ "version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }

Para obter mais informações, consulte Gerenciar endpoints de dispositivos principais no Guia do desenvolvedor do AWS IoT Greengrass V2.