AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

注册表事件

在创建、更新或删除了事物、事物类型和事物组时,注册表将发布事件消息。注册表当前支持以下事件类型:

事物已创建/已更新/已删除

在创建、更新或删除了事物时,注册表将发布以下事件消息:

  • $aws/events/thing/<thingName>/created

  • $aws/events/thing/<thingName>/updated

  • $aws/events/thing/<thingName>/deleted

消息包含以下示例负载:

{ "eventType" : "thingEvent", "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" } }

负载包含以下属性:

eventType

设置为“thingEvent”。

eventId

唯一事件 ID (字符串)。

timestamp

事件发生的 UNIX 时间戳。

operation

触发事件的操作。有效值为:

  • CREATED

  • UPDATED

  • DELETED

accountId

您的 AWS 账户 ID。

thingId

要创建、更新或删除的事物的 ID。

thingName

要创建、更新或删除的事物的名称。

versionNumber

要创建、更新或删除的事物的版本。在创建事物时,此值设置为 1。每次更新事物时,此值增加 1。

thingTypeName

与事物关联的事物类型 (如果存在)。否则为 null

个属性

与事物关联的名称/值对的集合。

事物类型已创建/已弃用/已取消弃用/已删除

在创建、弃用、取消弃用或删除了事物类型时,注册表将发布以下事件消息:

  • $aws/events/thingType/<thingTypeName>/created

  • $aws/events/thing/<thingTypeName>/updated

  • $aws/events/thing/<thingTypeName>/deleted

消息包含以下示例负载:

{ "eventType" : "thingTypeEvent", "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" }

负载包含以下属性:

eventType

设置为“thingTypeEvent”。

eventId

唯一事件 ID (字符串)。

timestamp

事件发生的 UNIX 时间戳。

operation

触发事件的操作。有效值为:

  • CREATED

  • UPDATED

  • DELETED

accountId

您的 AWS 账户 ID。

thingTypeId

要创建、弃用或删除的事物类型的 ID。

thingTypeName

要创建、弃用或删除的事物类型的名称。

isDeprecated

如果事物类型已弃用,则为 true。否则为 false

deprecationDate

弃用事物类型的 UNIX 时间戳。

searchableAttributes

与可用于搜索的事物类型关联的名称/值对集合。

description

事物类型的描述。

事物类型已与某个事物关联/取消关联

当事物类型与某个事物关联或取消关联时,注册表将发布以下事件消息。

  • $aws/events/thingTypeAssociation/thing/<thingName>/<typeName>

消息包含以下示例负载:

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

负载包含以下属性:

eventId

唯一事件 ID (字符串)。

eventType

设置为“THING_TYPE_ASSOCIATION_EVENT”。

operation

触发事件的操作。有效值为:

  • CREATED

  • DELETED

thingId

已更改其类型关联的事物的 ID。

thingName

已更改其类型关联的事物的名称。

thingTypeName

已与事物关联或不再与事物关联的事物类型。

timestamp

事件发生的 UNIX 时间戳。

事物组已创建/已更新/已删除

在创建、更新或删除了事物组时,注册表将发布以下事件消息。

  • $aws/events/thingGroup/<groupName>/created

  • $aws/events/thingGroup/<groupName>/updated

  • $aws/events/thingGroup/<groupName>/deleted

消息包含以下示例负载:

{ "eventType" : "thingGroupEvent", "eventId" : "87f8e095-531c-47b3-aab5-5171364d138d", "timestamp" : 1234567890123, "operation" : "CREATED|UPDATED|DELETED", "accountId" : "123456789012", "thingGroupId" : "8f82a106-6b1d-4331-8984-a84db5f6f8cb", "thingGroupName" : "MyRootThingGroup", "versionNumber" : 1, "parentGroupName" : null, "parentGroupId" : null, "description" : "My root thing group", "rootToParentThingGroups" : null, "attributes" : { "attribute1" : "value1", "attribute3" : "value3", "attribute2" : "value2" } }

负载包含以下属性:

eventType

设置为“thingGroupEvent”。

eventId

唯一事件 ID (字符串)。

timestamp

事件发生的 UNIX 时间戳。

operation

触发事件的操作。有效值为:

  • CREATED

  • UPDATED

  • DELETED

accountId

您的 AWS 账户 ID。

thingGroupId

要创建、更新或删除的事物组的 ID。

thingGroupName

要创建、更新或删除的事物组的名称。

versionNumber

事物组的版本。在创建事物组时,此值设置为 1。每次更新事物组时,此值增加 1。

parentGroupName

父事物组的名称 (如果存在)。

parentGroupId

父事物组的 ID (如果存在)。

description

事物组的描述。

rootToParentThingGroups

有关父事物组的信息数组。每个父事物组都有一个条目,以当前事物组的父级开始,继续直至达到根事物组。每个条目均包含事物组名称和事物组 ARN。

个属性

与事物组关联的名称/值对的集合。

事物已添加到/删除自事物组

当事物已添加到事物组或从事物组中删除时,注册表将发布以下事件消息。

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

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

消息包含以下示例负载:

{ "eventType" : "thingGroupMembershipEvent", "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" }

负载包含以下属性:

eventType

设置为“thingGroupMembershipEvent”。

eventId

事件 ID。

timestamp

事件发生的 UNIX 时间戳。

operation

当事物添加到事物组时为 ADDED。当事物从事物组中删除时为 REMOVED

accountId

您的 AWS 账户 ID。

groupArn

事物组的 ARN。

groupId

组的 ID。

thingArn

在事物组中添加或删除的事物的 ARN。

thingId

在事物组中添加或删除的事物的 ID。

membershipId

表示事物与事物组之间关系的 ID。将事物添加到事物组时生成此值。

事物组已添加到/删除自事物组

当某个事物组已添加到另一个事物组或从另一个事物组中删除时,注册表将发布以下事件消息。

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

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

消息包含以下示例负载:

{ "eventType" : "thingGroupHierarchyEvent", "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" }

负载包含以下属性:

eventType

设置为“thingGroupHierarchyEvent”。

eventId

事件 ID。

timestamp

事件发生的 UNIX 时间戳。

operation

当事物添加到事物组时为 ADDED。当事物从事物组中删除时为 REMOVED

accountId

您的 AWS 账户 ID。

thingGroupId

父事物组的 ID。

thingGroupName

父事物组的名称。

childGroupId

子事物组的 ID。

childGroupName

子事物组的名称。