D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
AWS IoT Greengrass V2 exemples utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with AWS IoT Greengrass V2.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utiliserassociate-service-role-to-account.
- AWS CLI
-
Pour associer le rôle de service Greengrass à votre compte AWS
L'
associate-service-role-to-accountexemple suivant associe un rôle de service à AWS IoT Greengrass pour votre AWS compte.aws greengrassv2 associate-service-role-to-account \ --role-arnarn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRoleSortie :
{ "associatedAt": "2022-01-19T19:21:53Z" }Pour plus d'informations, voir le rôle de service Greengrass dans le guide du développeur IoT AWS Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous AssociateServiceRoleToAccount
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserbatch-associate-client-device-with-core-device.
- AWS CLI
-
Pour associer des appareils clients à un périphérique principal
L'
batch-associate-client-device-with-core-deviceexemple suivant associe deux appareils clients à un périphérique principal.aws greengrassv2 batch-associate-client-device-with-core-device \ --core-device-thing-nameMyGreengrassCore\ --entriesthingName=MyClientDevice1thingName=MyClientDevice2Sortie :
{ "errorEntries": [] }Pour plus d'informations, consultez la section Interagir avec des appareils IoT locaux dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous BatchAssociateClientDeviceWithCoreDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserbatch-disassociate-client-device-from-core-device.
- AWS CLI
-
Pour dissocier les appareils clients d'un périphérique principal
L'
batch-disassociate-client-device-from-core-deviceexemple suivant dissocie deux appareils clients d'un périphérique principal.aws greengrassv2 batch-disassociate-client-device-from-core-device \ --core-device-thing-nameMyGreengrassCore\ --entriesthingName=MyClientDevice1thingName=MyClientDevice2Sortie :
{ "errorEntries": [] }Pour plus d'informations, consultez la section Interagir avec des appareils IoT locaux dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous BatchDisassociateClientDeviceFromCoreDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercancel-deployment.
- AWS CLI
-
Pour annuler un déploiement
L'
cancel-deploymentexemple suivant arrête un déploiement continu vers un groupe d'objets.aws greengrassv2 cancel-deployment \ --deployment-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111Sortie :
{ "message": "SUCCESS" }Pour plus d'informations, consultez la section Annuler des déploiements dans le guide du AWS développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous CancelDeployment
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-component-version.
- AWS CLI
-
Exemple 1 : pour créer une version de composant à partir d'une recette
L'
create-component-versionexemple suivant crée une version d'un composant Hello World à partir d'un fichier de recette.aws greengrassv2 create-component-version \ --inline-recipefileb://com.example.HelloWorld-1.0.0.jsonContenu 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}'" } } ] }Sortie :
{ "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": {} } }Pour plus d'informations, consultez les sections Création de composants personnalisés et Chargement de composants à déployer dans le Guide du développeur AWS IoT Greengrass V2.
Exemple 2 : pour créer une version de composant à partir d'une fonction AWS Lambda
L'
create-component-versionexemple suivant crée une version d'un composant Hello World à partir d'une fonction AWS Lambda.aws greengrassv2 create-component-version \ --cli-input-jsonfile://lambda-function-component.jsonContenu 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" } ] } } }Sortie :
{ "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": {} } }Pour plus d'informations, consultez la section Exécuter les fonctions AWS Lambda dans le guide du développeur IoT AWS Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous CreateComponentVersion
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-deployment.
- AWS CLI
-
Exemple 1 : pour créer un déploiement
L'
create-deploymentexemple suivant déploie l'interface de ligne de commande AWS IoT Greengrass sur un appareil principal.aws greengrassv2 create-deployment \ --cli-input-jsonfile://cli-deployment.jsonContenu 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": {} }Sortie :
{ "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }Pour plus d'informations, consultez la section Création de déploiements dans le guide du AWS développeur IoT Greengrass V2.
Exemple 2 : pour créer un déploiement qui met à jour les configurations des composants
L'
create-deploymentexemple suivant déploie le composant du noyau AWS IoT Greengrass sur un groupe d'appareils principaux. Ce déploiement applique les mises à jour de configuration suivantes pour le composant Nucleus :Réinitialisez les paramètres proxy des machines cibles à leurs paramètres par défaut sans proxy. Réinitialisez les paramètres MQTT des machines cibles à leurs valeurs par défaut.Définit les options JVM pour la JVM du noyau.Définit le niveau de journalisation du noyau.
aws greengrassv2 create-deployment \ --cli-input-jsonfile://nucleus-deployment.jsonContenu 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": {} }Sortie :
{ "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" }Pour plus d'informations, consultez la section Création de déploiements et mise à jour des configurations de composants dans le guide du AWS développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous CreateDeployment
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-component.
- AWS CLI
-
Pour supprimer la version d'un composant
L'
delete-componentexemple suivant supprime un composant Hello World.aws greengrassv2 delete-component \ --arnarn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous DeleteComponent
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-core-device.
- AWS CLI
-
Pour supprimer un appareil principal
L'
delete-core-deviceexemple suivant supprime un appareil AWS IoT Greengrass central.aws greengrassv2 delete-core-device \ --core-device-thing-nameMyGreengrassCoreCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Désinstaller le logiciel AWS IoT Greengrass Core dans le guide du développeur IoT AWS Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous DeleteCoreDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-component.
- AWS CLI
-
Pour décrire la version d'un composant
L'
describe-componentexemple suivant décrit un composant Hello World.aws greengrassv2 describe-component \ --arnarn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0Sortie :
{ "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" } } ] }Pour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous DescribeComponent
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdisassociate-service-role-from-account.
- AWS CLI
-
Pour dissocier le rôle de service Greengrass de votre compte AWS
L'
disassociate-service-role-from-accountexemple suivant dissocie le rôle de service Greengrass de AWS IoT Greengrass pour votre compte. AWSaws greengrassv2 disassociate-service-role-from-accountSortie :
{ "disassociatedAt": "2022-01-19T19:26:09Z" }Pour plus d'informations, voir le rôle de service Greengrass dans le guide du développeur IoT AWS Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous DisassociateServiceRoleFromAccount
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-component-version-artifact.
- AWS CLI
-
Pour obtenir une URL permettant de télécharger un artefact de composant
L'
get-component-version-artifactexemple suivant obtient une URL pour télécharger le fichier JAR du composant de console de débogage local.aws greengrassv2 get-component-version-artifact \ --arnarn:aws:greengrass:us-west-2:aws:components:aws.greengrass.LocalDebugConsole:versions:2.0.3\ --artifact-name"Uvt6ZEzQ9TKiAuLbfXBX_APdY0TWks3uc46tHFHTzBM=/aws.greengrass.LocalDebugConsole.jar"Sortie :
{ "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..." }Pour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetComponentVersionArtifact
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-component.
- AWS CLI
-
Exemple 1 : pour télécharger la recette d'un composant au format YAML (Linux, macOS ou Unix)
L'
get-componentexemple suivant télécharge la recette d'un composant Hello World dans un fichier au format YAML. Cette commande exécute les opérations suivantes :Utilise les
--queryparamètres--outputet pour contrôler le résultat de la commande. Ces paramètres extraient le blob de recettes de la sortie de la commande. Pour plus d'informations sur le contrôle de la sortie, voir Contrôle de la sortie des commandes dans le Guide de l'utilisateur de l'interface de ligne de AWS commande. Utilise l'base64utilitaire. Cet utilitaire décode le blob extrait selon le texte d'origine. Le blob renvoyé par uneget-componentcommande réussie est du texte codé en base64. Vous devez décoder ce blob pour obtenir le texte original. Enregistre le texte décodé dans un fichier. La dernière section de la commande (> com.example.HelloWorld-1.0.0.json) enregistre le texte décodé dans un fichier.aws greengrassv2 get-component \ --arnarn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0\ --recipe-output-formatYAML\ --queryrecipe\ --outputtext|base64--decode>com.example.HelloWorld-1.0.0.jsonPour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
Exemple 2 : pour télécharger la recette d'un composant au format YAML (Windows CMD)
L'
get-componentexemple suivant télécharge la recette d'un composant Hello World dans un fichier au format YAML. Cette commande utilise l'certutilutilitaire.aws greengrassv2 get-component^--arnarn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0^--recipe-output-formatYAML^--queryrecipe^--outputtext>com.example.HelloWorld-1.0.0.yaml.b64certutil-decodecom.example.HelloWorld-1.0.0.yaml.b64com.example.HelloWorld-1.0.0.yamlPour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
Exemple 3 : pour télécharger la recette d'un composant au format YAML (Windows PowerShell)
L'
get-componentexemple suivant télécharge la recette d'un composant Hello World dans un fichier au format YAML. Cette commande utilise l'certutilutilitaire.aws greengrassv2 get-component`--arnarn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0`--recipe-output-formatYAML`--queryrecipe`--outputtext>com.example.HelloWorld-1.0.0.yaml.b64certutil-decodecom.example.HelloWorld-1.0.0.yaml.b64com.example.HelloWorld-1.0.0.yamlPour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetComponent
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-connectivity-info.
- AWS CLI
-
Pour obtenir les informations de connectivité d'un appareil Greengrass Core
L'
get-connectivity-infoexemple suivant permet d'obtenir les informations de connectivité d'un appareil Greengrass Core. Les appareils clients utilisent ces informations pour se connecter au broker MQTT qui s'exécute sur ce périphérique principal.aws greengrassv2 get-connectivity-info \ --thing-nameMyGreengrassCoreSortie :
{ "connectivityInfo": [ { "id": "localIP_192.0.2.0", "hostAddress": "192.0.2.0", "portNumber": 8883 } ] }Pour plus d'informations, consultez la section Gérer les principaux points de terminaison des appareils dans le guide du AWS développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetConnectivityInfo
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-core-device.
- AWS CLI
-
Pour obtenir un appareil principal
L'
get-core-deviceexemple suivant permet d'obtenir des informations sur un AWS appareil IoT Greengrass central.aws greengrassv2 get-core-device \ --core-device-thing-nameMyGreengrassCoreSortie :
{ "coreDeviceThingName": "MyGreengrassCore", "coreVersion": "2.0.3", "platform": "linux", "architecture": "amd64", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00", "tags": {} }Pour plus d'informations, consultez la section Vérifier l'état de l'appareil principal dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetCoreDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-deployment.
- AWS CLI
-
Pour obtenir un déploiement
L'
get-deploymentexemple suivant fournit des informations sur le déploiement du composant AWS IoT Greengrass nucleus sur un groupe d'appareils principaux.aws greengrassv2 get-deployment \ --deployment-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111Sortie :
{ "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": {} }Pour plus d'informations, consultez la section Déployer des composants sur des appareils dans le AWS guide du développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetDeployment
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-service-role-for-account.
- AWS CLI
-
Pour obtenir le rôle de service Greengrass associé à votre compte AWS
L'
get-service-role-for-accountexemple suivant montre le rôle de service associé à AWS IoT Greengrass pour votre AWS compte.aws greengrassv2 get-service-role-for-accountSortie :
{ "associatedAt": "2022-01-19T19:21:53Z", "roleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" }Pour plus d'informations, voir le rôle de service Greengrass dans le guide du développeur IoT AWS Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous GetServiceRoleForAccount
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-client-devices-associated-with-core-device.
- AWS CLI
-
Pour répertorier les appareils clients associés à un périphérique principal
L'
list-client-devices-associated-with-core-deviceexemple suivant répertorie tous les appareils clients associés à un périphérique principal.aws greengrassv2 list-client-devices-associated-with-core-device \ --core-device-thing-nameMyTestGreengrassCoreSortie :
{ "associatedClientDevices": [ { "thingName": "MyClientDevice2", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" }, { "thingName": "MyClientDevice1", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" } ] }Pour plus d'informations, consultez la section Interagir avec des appareils IoT locaux dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListClientDevicesAssociatedWithCoreDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-component-versions.
- AWS CLI
-
Pour répertorier les versions d'un composant
L'
list-component-versionsexemple suivant répertorie toutes les versions d'un composant Hello World.aws greengrassv2 list-component-versions \ --arnarn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorldSortie :
{ "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" } ] }Pour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListComponentVersions
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-components.
- AWS CLI
-
Pour répertorier les composants
L'
list-componentsexemple suivant répertorie chaque composant et sa dernière version définis dans votre AWS compte dans la région actuelle.aws greengrassv2 list-componentsSortie :
{ "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" } } ] } } ] }Pour plus d'informations, consultez la section Gérer les composants dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListComponents
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-core-devices.
- AWS CLI
-
Pour répertorier les principaux appareils
L'
list-core-devicesexemple suivant répertorie les principaux appareils AWS IoT Greengrass de votre AWS compte dans la région actuelle.aws greengrassv2 list-core-devicesSortie :
{ "coreDevices": [ { "coreDeviceThingName": "MyGreengrassCore", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00" } ] }Pour plus d'informations, consultez la section Vérifier l'état de l'appareil principal dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListCoreDevices
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-deployments.
- AWS CLI
-
Pour répertorier les déploiements
L'
list-deploymentsexemple suivant répertorie la dernière révision de chaque déploiement défini dans votre AWS compte dans la région actuelle.aws greengrassv2 list-deploymentsSortie :
{ "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 } ] }Pour plus d'informations, consultez la section Déployer des composants sur des appareils dans le AWS guide du développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListDeployments
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-effective-deployments.
- AWS CLI
-
Pour répertorier les tâches de déploiement
L'
list-effective-deploymentsexemple suivant répertorie les déploiements qui s'appliquent à un appareil principal AWS IoT Greengrass.aws greengrassv2 list-effective-deployments \ --core-device-thing-nameMyGreengrassCoreSortie :
{ "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" } ] }Pour plus d'informations, consultez la section Vérifier l'état de l'appareil principal dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListEffectiveDeployments
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-installed-components.
- AWS CLI
-
Pour répertorier les composants installés sur un périphérique principal
L'
list-installed-componentsexemple suivant répertorie les composants installés sur un appareil AWS IoT Greengrass central.aws greengrassv2 list-installed-components \ --core-device-thing-nameMyGreengrassCoreSortie :
{ "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 } ] }Pour plus d'informations, consultez la section Vérifier l'état de l'appareil principal dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListInstalledComponents
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-tags-for-resource.
- AWS CLI
-
Pour répertorier les balises d'une ressource
L'
list-tags-for-resourceexemple suivant répertorie toutes les balises d'un appareil AWS IoT Greengrass central.aws greengrassv2 list-tags-for-resource \ --resource-arnarn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCoreSortie :
{ "tags": { "Owner": "richard-roe" } }Pour plus d'informations, consultez la section Marquer vos ressources dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous ListTagsForResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisertag-resource.
- AWS CLI
-
Ajout d’une balise à une ressource
L'
tag-resourceexemple suivant ajoute une étiquette de propriétaire à un appareil AWS IoT Greengrass central. Vous pouvez utiliser cette balise pour contrôler l'accès à l'appareil principal en fonction de son propriétaire.aws greengrassv2 tag-resource \ --resource-arnarn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore\ --tagsOwner=richard-roeCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Marquer vos ressources dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous TagResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseruntag-resource.
- AWS CLI
-
Pour supprimer un tag d'une ressource
L'
untag-resourceexemple suivant supprime une étiquette de propriétaire d'un appareil AWS IoT Greengrass central.aws iotsitewise untag-resource \ --resource-arnarn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore\ --tag-keysOwnerCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Marquer vos ressources dans le guide du développeur AWS IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous UntagResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-connectivity-info.
- AWS CLI
-
Pour mettre à jour les informations de connectivité d'un appareil Greengrass Core
L'
update-connectivity-infoexemple suivant permet d'obtenir les informations de connectivité d'un appareil Greengrass Core. Les appareils clients utilisent ces informations pour se connecter au broker MQTT qui s'exécute sur ce périphérique principal.aws greengrassv2 update-connectivity-info \ --thing-nameMyGreengrassCore\ --cli-input-jsonfile://core-device-connectivity-info.jsonContenu de
core-device-connectivity-info.json:{ "connectivityInfo": [ { "hostAddress": "192.0.2.0", "portNumber": 8883, "id": "localIP_192.0.2.0" } ] }Sortie :
{ "version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }Pour plus d'informations, consultez la section Gérer les principaux points de terminaison des appareils dans le guide du AWS développeur IoT Greengrass V2.
-
Pour plus de détails sur l'API, reportez-vous UpdateConnectivityInfo
à la section Référence des AWS CLI commandes.
-