Événements de registre - AWS IoT Core

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.

Événements de registre

Le registre peut publier des messages d'événement lorsque des objets, des types d'objets et des groupes d'objets sont créés, mis à jour ou supprimés. Ces événements ne sont cependant pas disponibles par défaut. Pour plus d'informations sur la façon d'activer ces événements, consultez Activez les événements pour AWS IoT.

Le registre peut fournir les types d'événements suivants :

Événements de l’objet

Objet créé/mis à jour/supprimé

Le registre publie les messages d'événement suivants lorsque des objets sont créés, mis à jour ou supprimés :

  • $aws/events/thing/thingName/created

  • $aws/events/thing/thingName/updated

  • $aws/events/thing/thingName/deleted

Les messages contiennent l'exemple de charge utile suivant :

{ "eventType" : "THING_EVENT", "eventId" : "f5ae9b94-8b8e-4d8e-8c8f-b3266dd89853", "timestamp" : 1234567890123, "operation" : "CREATED|UPDATED|DELETED", "accountId" : "123456789012", "thingId" : "b604f69c-aa9a-4d4a-829e-c480e958a0b5", "thingName" : "MyThing", "versionNumber" : 1, "thingTypeName" : null, "attributes": { "attribute3": "value3", "attribute1": "value1", "attribute2": "value2" } }

Les charges utiles contiennent les attributs suivants :

eventType

Défini sur « THING_EVENT ».

eventId

Un ID d'événement unique (chaîne).

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

fonctionnement

L'opération qui a déclenché l'événement. Les valeurs valides sont :

  • CRÉÉ

  • MIS À JOUR

  • SUPPRIMÉ

accountId

Votre Compte AWS carte d'identité.

thingId

L'ID de l'objet en cours de création, de mise à jour ou de suppression.

thingName

Le nom de l'objet en cours de création, de mise à jour ou de suppression.

versionNumber

La version de l'objet en cours de création, de mise à jour ou de suppression. Cette valeur est définie sur 1 lors de la création d'un objet. Elle augmente de 1 à chaque mise à jour de l'objet.

thingTypeName

Le type d'objet associé à l'objet, le cas échéant. Sinon la valeur est renvoy, null.

attributs

Un ensemble de paires nom-valeur associées à l'objet.

Événements de types d'objet

Type d'objet créé/obsolète/dont l'obsolescence est annulée/supprimé

Le registre publie les messages d'événement suivants lorsque des types d'objets sont créés, obsolètes, supprimés ou que leur obsolescence est annulée :

  • $aws/events/thingType/thingTypeName/created

  • $aws/events/thingType/thingTypeName/updated

  • $aws/events/thingType/thingTypeName/deleted

Le message contient l'exemple de charge utile suivant :

{ "eventType" : "THING_TYPE_EVENT", "eventId" : "8827376c-4b05-49a3-9b3b-733729df7ed5", "timestamp" : 1234567890123, "operation" : "CREATED|UPDATED|DELETED", "accountId" : "123456789012", "thingTypeId" : "c530ae83-32aa-4592-94d3-da29879d1aac", "thingTypeName" : "MyThingType", "isDeprecated" : false|true, "deprecationDate" : null, "searchableAttributes" : [ "attribute1", "attribute2", "attribute3" ], "description" : "My thing type" }

Les charges utiles contiennent les attributs suivants :

eventType

Défini sur « THING_TYPE_EVENT ».

eventId

Un ID d'événement unique (chaîne).

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

fonctionnement

L'opération qui a déclenché l'événement. Les valeurs valides sont :

  • CRÉÉ

  • MIS À JOUR

  • SUPPRIMÉ

accountId

Votre Compte AWS carte d'identité.

thingTypeId

L'ID du type d'objet en cours de création, de suppression ou de déclaration d'obsolescence.

thingTypeName

Le nom du type d'objet en cours de création, de suppression ou de déclaration d'obsolescence.

isDeprecated

true si le type d'objet est obsolète. Sinon la valeur est renvoy, false.

deprecationDate

L'horodatage UNIX associé au moment où ce type d'objet est devenu obsolète.

searchableAttributes

Un ensemble de paires nom-valeur associées au type d'objet qui peut être utilisé pour la recherche.

description

Une description du type d'objet.

Type d'objet associé à un objet/dissocié d'un objet

Le registre publie les messages d'événement suivants lorsqu'un type d'objet est associé à un objet ou dissocié d'un objet.

  • $aws/events/thingTypeAssociation/thing/thingName/thingType/typeName/added

  • $aws/events/thingTypeAssociation/thing/thingName/thingType/typeName/removed

Voici un exemple de charge utile added. Les charges utiles pour les messages removed sont similaires.

{ "eventId" : "87f8e095-531c-47b3-aab5-5171364d138d", "eventType" : "THING_TYPE_ASSOCIATION_EVENT", "operation" : "ADDED", "thingId" : "b604f69c-aa9a-4d4a-829e-c480e958a0b5", "thingName": "myThing", "thingTypeName" : "MyThingType", "timestamp" : 1234567890123, }

Les charges utiles contiennent les attributs suivants :

eventId

Un ID d'événement unique (chaîne).

eventType

Défini sur « THING_TYPE_ASSOCIATION_EVENT ».

fonctionnement

L'opération qui a déclenché l'événement. Les valeurs valides sont :

  • AJOUTÉ

  • SUPPRIMÉ

thingId

ID de l'objet dont l'association du type a été modifiée.

thingName

Nom de l'objet dont l'association du type a été modifiée.

thingTypeName

Type d'objet associé à l'objet ou qui n'est plus associé à l'objet.

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

Événements de groupe d'objets

Type d'objet créé/mis à jour/supprimé

Le registre publie les messages d'événement suivants lorsqu'un groupe d'objets est créé, mis à jour ou supprimé.

  • $aws/events/thingGroup/groupName/created

  • $aws/events/thingGroup/groupName/updated

  • $aws/events/thingGroup/groupName/deleted

Voici un exemple de charge utile updated. Les charges utiles pour created et des messages deleted sont similaires.

{ "eventType": "THING_GROUP_EVENT", "eventId": "8b9ea8626aeaa1e42100f3f32b975899", "timestamp": 1603995417409, "operation": "UPDATED", "accountId": "571EXAMPLE833", "thingGroupId": "8757eec8-bb37-4cca-a6fa-403b003d139f", "thingGroupName": "Tg_level5", "versionNumber": 3, "parentGroupName": "Tg_level4", "parentGroupId": "5fce366a-7875-4c0e-870b-79d8d1dce119", "description": "New description for Tg_level5", "rootToParentThingGroups": [ { "groupArn": "arn:aws:iot:us-west-2:571EXAMPLE833:thinggroup/TgTopLevel", "groupId": "36aa0482-f80d-4e13-9bff-1c0a75c055f6" }, { "groupArn": "arn:aws:iot:us-west-2:571EXAMPLE833:thinggroup/Tg_level1", "groupId": "bc1643e1-5a85-4eac-b45a-92509cbe2a77" }, { "groupArn": "arn:aws:iot:us-west-2:571EXAMPLE833:thinggroup/Tg_level2", "groupId": "0476f3d2-9beb-48bb-ae2c-ea8bd6458158" }, { "groupArn": "arn:aws:iot:us-west-2:571EXAMPLE833:thinggroup/Tg_level3", "groupId": "1d9d4ffe-a6b0-48d6-9de6-2e54d1eae78f" }, { "groupArn": "arn:aws:iot:us-west-2:571EXAMPLE833:thinggroup/Tg_level4", "groupId": "5fce366a-7875-4c0e-870b-79d8d1dce119" } ], "attributes": { "attribute1": "value1", "attribute3": "value3", "attribute2": "value2" }, "dynamicGroupMappingId": null }

Les charges utiles contiennent les attributs suivants :

eventType

Défini sur « THING_GROUP_EVENT ».

eventId

Un ID d'événement unique (chaîne).

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

fonctionnement

L'opération qui a déclenché l'événement. Les valeurs valides sont :

  • CRÉÉ

  • MIS À JOUR

  • SUPPRIMÉ

accountId

Votre Compte AWS carte d'identité.

thingGroupId

L'ID du groupe d'objets en cours de création, de mise à jour ou de suppression.

thingGroupName

Le nom du groupe d'objets en cours de création, de mise à jour ou de suppression.

versionNumber

Version du groupe d'objets. Cette valeur est définie sur 1 lors de la création d'un groupe d'objets. Elle augmente de 1 à chaque mise à jour du groupe d'objets.

parentGroupName

Le nom du groupe d'objets parent (le cas échéant).

parentGroupId

L'ID du groupe d'objets parent (le cas échéant).

description

La description du groupe d'objets.

rootToParentThingGroups

Tableau d'informations sur le groupe d'objets parent. Il existe un élément pour chaque groupe d'objets parent, en commençant par le groupe d'objets racine et en continuant jusqu'au parent du groupe d'objets. Chaque entrée contient les groupes d'objets groupArn et groupId.

attributs

Un ensemble de paires nom-valeur associées au groupe d'objets.

Objet ajouté à un groupe d'objets/retiré d'un groupe d'objets

Le registre publie les messages d'événement suivants lorsqu'un objet est ajouté à un groupe d'objets ou retiré d'un groupe d'objets.

  • $aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/added

  • $aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/removed

Les messages contiennent l'exemple de charge utile suivant :

{ "eventType" : "THING_GROUP_MEMBERSHIP_EVENT", "eventId" : "d684bd5f-6f6e-48e1-950c-766ac7f02fd1", "timestamp" : 1234567890123, "operation" : "ADDED|REMOVED", "accountId" : "123456789012", "groupArn" : "arn:aws:iot:ap-northeast-2:123456789012:thinggroup/MyChildThingGroup", "groupId" : "06838589-373f-4312-b1f2-53f2192291c4", "thingArn" : "arn:aws:iot:ap-northeast-2:123456789012:thing/MyThing", "thingId" : "b604f69c-aa9a-4d4a-829e-c480e958a0b5", "membershipId" : "8505ebf8-4d32-4286-80e9-c23a4a16bbd8" }

Les charges utiles contiennent les attributs suivants :

eventType

Défini sur « THING_GROUP_MEMBERSHIP_EVENT ».

eventId

L'ID d'événement.

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

fonctionnement

ADDED lorsqu' un objet est ajouté à un groupe d'objets. REMOVED lorsqu'un objet est supprimé d'un groupe d'objets.

accountId

Votre Compte AWS carte d'identité.

groupArn

L'ARN du groupe d'objets.

groupId

L'ID du groupe.

thingArn

L'ARN de l'objet qui a été ajouté au groupe d'objets ou supprimé de ce groupe.

thingId

L'ID de l'objet qui a été ajouté au groupe d'objets ou supprimé de ce groupe.

membershipId

Un ID qui représente la relation entre l'objet et le groupe d'objets. Cette valeur est générée lorsque vous ajoutez un objet à un groupe d'objets.

Groupe d'objets ajouté à un groupe d'objets/retiré d'un groupe d'objets

Le registre publie les messages d'événement suivants lorsqu'un groupe d'objets est ajouté à un autre groupe d'objets ou retiré d'un autre groupe d'objets.

  • $aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/added

  • $aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/removed

Le message contient l'exemple de charge utile suivant :

{ "eventType" : "THING_GROUP_HIERARCHY_EVENT", "eventId" : "264192c7-b573-46ef-ab7b-489fcd47da41", "timestamp" : 1234567890123, "operation" : "ADDED|REMOVED", "accountId" : "123456789012", "thingGroupId" : "8f82a106-6b1d-4331-8984-a84db5f6f8cb", "thingGroupName" : "MyRootThingGroup", "childGroupId" : "06838589-373f-4312-b1f2-53f2192291c4", "childGroupName" : "MyChildThingGroup" }

Les charges utiles contiennent les attributs suivants :

eventType

Défini sur « THING_GROUP_HIERARCHY_EVENT ».

eventId

L'ID d'événement.

timestamp

L'horodatage UNIX du moment où l'événement s'est produit.

fonctionnement

ADDED lorsqu' un objet est ajouté à un groupe d'objets. REMOVED lorsqu'un objet est supprimé d'un groupe d'objets.

accountId

Votre Compte AWS carte d'identité.

thingGroupId

L'ID du groupe d'objets parent.

thingGroupName

Le nom du groupe d'objets parent.

childGroupId

L'ID du groupe d'objets enfant.

childGroupName

Le nom du groupe d'objets enfant.