Gérer l'indexation du groupe d'objet

AWS_ThingGroupsest l'index qui contient tous vos groupes d'objets et groupes de facturation. Cet index vous permet de rechercher des groupes en fonction de leur nom, de la description, des attributs et de tous les noms de groupes parents.

Activation de l'indexation de groupes d'objets

Vous pouvez utiliser le thing-group-indexing-configuration paramètre de l'API UpdateIndexingde configuration pour créer l'AWS_ThingGroupsindex et contrôler sa configuration. Vous pouvez utiliser l'API GetIndexingde configuration pour récupérer la configuration d'indexation actuelle.

Pour mettre à jour les configurations d'indexation des groupes d'objets, exécutez la commande CLI update-indexing-configuration :

aws iot update-indexing-configuration --thing-group-indexing-configuration thingGroupIndexingMode=ON

Vous pouvez également mettre à jour les configurations d'indexation d'objets et de groupes d'objets avec une seule commande, comme indiqué ci-dessous  :

aws iot update-indexing-configuration --thing-indexing-configuration thingIndexingMode=REGISTRY --thing-group-indexing-configuration thingGroupIndexingMode=ON

Les valeurs suivantes sont valides pour thingGroupIndexingMode.

OFF

Pas d'indexation/suppression de l'index.

ON

Créez ou configurez l'index AWS_ThingGroups.

Pour récupérer les configurations actuelles d'indexation des objets et des groupes d'objets, exécutez la commande CLI get-indexing-configuration :

aws iot get-indexing-configuration

La réponse de la commande ressemble à ce qui suit :

{
   "thingGroupIndexingConfiguration": {
        "thingGroupIndexingMode": "ON"
    }
}

Description des index de groupes

Pour récupérer l'état actuel de l'index AWS_ThingGroups, utilisez la commande CLI describe-index :

aws iot describe-index --index-name "AWS_ThingGroups"

La réponse de la commande ressemble à ce qui suit :

{
   "indexStatus": "ACTIVE", 
   "indexName": "AWS_ThingGroups", 
   "schema": "THING_GROUPS"
}

AWS IoT crée votre index la première fois que vous indexez. Vous ne pouvez pas interroger l'index si le indexStatus est BUILDING.

Interrogation d'un index de groupes d'objets

Pour interroger les données de l'index, utilisez la commande CLI search-index :

aws iot search-index --index-name "AWS_ThingGroups" --query-string "thingGroupName:mythinggroup*"

Autorisation

Vous pouvez spécifier l'index des groupes d'objets en tant qu'ARN de ressource dans le cadre d'une action de AWS IoT politique, comme suit.

Action	Ressource
iot:SearchIndex	Un ARN d'index (par exemple, arn:aws:iot:your-aws-region:index/AWS_ThingGroups).
iot:DescribeIndex	Un ARN d'index (par exemple, arn:aws:iot:your-aws-region:index/AWS_ThingGroups).