

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 登録イベント
<a name="registry-events"></a>

モノ、モノのタイプ、モノのグループが作成、更新、または削除されたときに、レジストリでのイベントメッセージ発行が可能になります。ただし、これらのイベントはデフォルトでは使用できません。これらのイベントを有効にする方法の詳細については、[のイベントを有効にする AWS IoT](iot-events.md#iot-events-enable) を参照してください。

**Topics**
+ [モノのイベント](#registry-events-thing)
+ [モノのタイプのイベント](#registry-events-thingtype)
+ [モノのグループのイベント](#registry-events-thinggroup)

## モノのイベント
<a name="registry-events-thing"></a>

**モノの作成/更新/削除**

レジストリは、モノが作成、更新、または削除されると次のイベントメッセージを発行します。
+ `$aws/events/thing/thingName/created`
+ `$aws/events/thing/thingName/updated`
+ `$aws/events/thing/thingName/deleted`

メッセージには、次のペイロード例が含まれています。

```
{
    "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"
    }
}
```

ペイロードには次の属性が含まれます。

eventType  
「THING\$1EVENT」に設定します。

eventId  
一意のイベント ID (文字列)。

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

オペレーション  
イベントをトリガーしたオペレーション。有効な値は次のとおりです。  
+ CREATED
+ UPDATED
+ 削除済み

accountId  
 AWS アカウント ID。

thingId  
作成、更新、または削除されているモノの ID。

thingName  
作成、更新、または削除されているモノの名前。

versionNumber  
作成、更新、または削除されているモノのバージョン。この値は、モノが作成されると 1 に設定されます。これは、モノが更新されるたびに 1 ずつ増加します。

thingTypeName  
新しいモノに関連付けられたモノのタイプの名前 (存在する場合)。そうでない場合は、`null` です。

個の属性  
モノに関連付けられた名前と値のペアの集合。

## モノのタイプのイベント
<a name="registry-events-thingtype"></a>

**Topics**
+ [作成/更新/廃止/復帰/削除されたモノのタイプ](#registry-events-thingtype-crud)
+ [モノに関連付けまたは関連付け解除されたモノのタイプ](#registry-events-thingtype-assoc)

### 作成/更新/廃止/復帰/削除されたモノのタイプ
<a name="registry-events-thingtype-crud"></a>

レジストリは、モノのタイプが作成、更新、廃止、復帰、または削除されると、次のイベントメッセージを発行します。
+ `$aws/events/thingType/thingTypeName/created`
+ `$aws/events/thingType/thingTypeName/updated`
+ `$aws/events/thingType/thingTypeName/deleted`

メッセージには、次の例のペイロードが含まれています。

```
{
    "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" ],
    "propagatingAttributes": [
        {
	    "userPropertyKey": "key",
	    "thingAttribute": "model"
        },
        {
	    "userPropertyKey": "key",
	    "connectionAttribute": "iot:ClientId"
        }
    ],
    "description" : "My thing type"
}
```

ペイロードには次の属性が含まれます。

eventType  
「THING\$1TYPE\$1EVENT」に設定します。

eventId  
一意のイベント ID (文字列)。

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

オペレーション  
イベントをトリガーしたオペレーション。有効な値は次のとおりです。  
+ CREATED
+ UPDATED
+ 削除済み

accountId  
 AWS アカウント ID。

thingTypeId  
作成、更新、廃止、または削除されているモノのタイプの ID。

thingTypeName  
作成、更新、廃止、または削除されているモノのタイプの名前。

isDeprecated  
`true` モノのタイプは廃止されている場合。そうでない場合は、`false` です。

deprecationDate  
モノのタイプが廃止されたときの UNIX タイムスタンプ。

searchableAttributes  
検索に使用できるモノのタイプに関連付けられた名前と値のペアの集合。

propagatingAttributes  
伝播属性のリスト。伝達属性には、モノの属性、接続属性、およびユーザープロパティキーを含めることができます。詳細については、「[メッセージエンリッチメントの伝播属性の追加](https://docs.aws.amazon.com//iot/latest/developerguide/thing-types-propagating-attributes.html)」を参照してください。

説明  
モノのタイプの説明。

### モノに関連付けまたは関連付け解除されたモノのタイプ
<a name="registry-events-thingtype-assoc"></a>

レジストリは、モノのタイプがモノに関連付けまたは関連付け解除されると、次のイベントメッセージを発行します。
+ `$aws/events/thingTypeAssociation/thing/thingName/thingType/typeName/added`
+ `$aws/events/thingTypeAssociation/thing/thingName/thingType/typeName/removed`

`added` ペイロードの例を次に示します。`removed` メッセージのペイロードは類似しています。

```
{
    "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,
}
```

ペイロードには次の属性が含まれます。

eventId  
一意のイベント ID (文字列)。

eventType  
「THING\$1TYPE\$1ASSOCIATION\$1EVENT」に設定します。

オペレーション  
イベントをトリガーしたオペレーション。次の値を指定できます。  
+ 追加
+ 削除済み

thingId  
タイプの関連付けが変更されたモノの ID。

thingName  
タイプの関連付けが変更されたモノの名前。

thingTypeName  
モノと関連付けられた、または関連付けが解除されたモノのタイプ。

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

## モノのグループのイベント
<a name="registry-events-thinggroup"></a>

**Topics**
+ [作成/更新/削除されたモノのグループ](#registry-events-thinggroup-crud)
+ [モノのグループに対して追加または削除されたモノ](#registry-events-thinggroup-addremove)
+ [モノのグループに対して追加または削除されたモノのグループ](#registry-events-thinggroup-adddelete)

### 作成/更新/削除されたモノのグループ
<a name="registry-events-thinggroup-crud"></a>

レジストリは、モノのグループが作成、更新、または削除されると次のイベントメッセージを発行します。
+ `$aws/events/thingGroup/groupName/created`
+ `$aws/events/thingGroup/groupName/updated`
+ `$aws/events/thingGroup/groupName/deleted`

`updated` ペイロードの例を次に示します。`created` と `deleted` メッセージのペイロードは類似しています。

```
{
  "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
}
```

ペイロードには次の属性が含まれます。

eventType  
「THING\$1GROUP\$1EVENT」に設定します。

eventId  
一意のイベント ID (文字列)。

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

オペレーション  
イベントをトリガーしたオペレーション。有効な値は次のとおりです。  
+ CREATED
+ UPDATED
+ 削除済み

accountId  
 AWS アカウント ID。

thingGroupId  
作成、更新、または削除されているモノのグループの ID。

thingGroupName  
作成、更新、または削除されているモノのグループの名前。

versionNumber  
モノのグループのバージョン。この値は、モノのグループが作成されると 1 に設定されます。これは、モノのグループが更新されるたびに 1 ずつ増加します。

parentGroupName  
親モノグループの名前 (存在する場合)。

parentGroupId  
親モノグループの ID (存在する場合)。

description  
モノのグループの説明。

rootToParentThingGroups  
親モノのグループについての情報の配列。モノの親グループごとに 1 つの要素があり、モノのルートグループから始まり、そのモノのグループの親まで続きます。各エントリには、モノのグループの `groupArn` と `groupId` が含まれています。

個の属性  
モノのグループに関連付けられた名前と値のペアの集合。

### モノのグループに対して追加または削除されたモノ
<a name="registry-events-thinggroup-addremove"></a>

レジストリは、モノがモノのグループに対して追加または削除されると、次のイベントメッセージを発行します。
+ `$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/added`
+ `$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/removed`

メッセージには、次のペイロード例が含まれています。

```
{
    "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"
}
```

ペイロードには次の属性が含まれます。

eventType  
「THING\$1GROUP\$1MEMBERSHIP\$1EVENT」に設定します。

eventId  
イベントの ID｡

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

オペレーション  
`ADDED` モノのグループにモノが追加されると送信されます。`REMOVED` モノのグループからモノが削除されると送信されます。

accountId  
 AWS アカウント ID。

groupArn  
モノのグループの ARN｡

groupId  
グループの ID｡

thingArn  
モノのグループに追加または削除されたモノの ARN。

thingId  
モノのグループに追加または削除されたモノの ID。

membershipId  
モノとモノの間の関係を表す ID。この値は、モノをモノのグループに追加するときに生成されます。

### モノのグループに対して追加または削除されたモノのグループ
<a name="registry-events-thinggroup-adddelete"></a>

レジストリは、モノのグループが別のモノのグループに対して追加または削除されると、次のイベントメッセージを発行します。
+ `$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/added`
+ `$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/removed`

メッセージには、次の例のペイロードが含まれています。

```
{
    "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"
}
```

ペイロードには次の属性が含まれます。

eventType  
「THING\$1GROUP\$1HIERARCHY\$1EVENT」に設定します。

eventId  
イベントの ID｡

timestamp  
イベントが発生したときの UNIX タイムスタンプ。

オペレーション  
`ADDED` モノのグループにモノが追加されると送信されます。`REMOVED` モノのグループからモノが削除されると送信されます。

accountId  
 AWS アカウント ID。

thingGroupId  
親モノのグループの ID

thingGroupName  
親モノのグループの名前。

childGroupId  
子モノのグループの ID

childGroupName  
子モノのグループの名前。