イベントメッセージ

このセクションには、モノやジョブが更新または変更された AWS IoT ときにによって発行されるメッセージに関する情報が含まれています。ディテクターを作成して、デバイスのオペレーションの障害や変更をモニタリングし、それらが発生したときにアクションをトリガーできる AWS IoT Events サービスについては、「」を参照してくださいAWS IoT Events。

イベントメッセージが生成される方法

AWS IoT は、特定のイベントが発生したときにイベントメッセージを発行します。例えば、モノが追加、更新、または削除されると、イベントがレジストリによって生成されます。各イベントによって、単一のイベントメッセージが送信されます。イベントメッセージは、MQTT を介して JSON ペイロードを使用して公開されます。ペイロードのコンテンツは、イベントの種類によって異なります。

注記

イベントメッセージは一度公開されることが保証されています。複数回発行することが可能です。イベントメッセージの順序は保証されません。

イベントメッセージを受信するためのポリシー

イベントメッセージを受信するには、デバイスが AWS IoT デバイスゲートウェイに接続し、MQTT イベントトピックをサブスクライブできるようにする適切なポリシーを使用する必要があります。また、適切なトピックフィルターを受信登録する必要があります。

以下に示しているのは、ライフサイクルイベントの受信に必要なポリシーの例です。


{
    "Version":"2012-10-17",
    "Statement":[{
        "Effect":"Allow",
        "Action":[
            "iot:Subscribe",
            "iot:Receive"
        ],
        "Resource":[
            "arn:aws:iot:region:account:/$aws/events/*"
        ]
    }]
}

のイベントを有効にする AWS IoT

予約済みトピックのサブスクライバーがメッセージを受信できるようにするには、から、 AWS Management Console または API または CLI を使用してイベントメッセージを有効にする必要があります。さまざまなオプションが管理するイベントメッセージの詳細については、AWS IoT 「イベント設定の表」を参照してください。

イベントメッセージを有効にするには、 AWS IoT コンソールの設定タブに移動し、イベントベースのメッセージセクションで、イベントの管理 を選択します。管理したいイベントを指定ができます。
API または CLI を使用して発行されるイベントタイプを制御するには、UpdateEventConfigurations API を呼び出すか、 update-event-configurations CLI コマンドを使用します。例:
```
aws iot update-event-configurations --event-configurations "{\"THING\":{\"Enabled\": true}}"
```

注記

二重引用符 (") はバックスラッシュ (\) でエスケープされます。

現在のイベント設定を取得するには、DescribeEventConfigurations API を呼び出すかdescribe-event-configurations、 CLI コマンドを使用します。例 :


aws iot describe-event-configurations

AWS IoT イベント構成設定表

イベントカテゴリ（AWS IoT コンソール: 設定: イベントベースのメッセージ）	`eventConfigurations` キーバリュー (AWS CLI/API)	イベントメッセージのトピック
( AWS CLI/API を使用してのみ設定可能)	`CA_CERTIFICATE`	`$aws/events/certificates/registered/caCertificateId`
( AWS CLI/API を使用してのみ設定可能)	`CERTIFICATE`	`$aws/events/presence/connected/clientId`
( AWS CLI/API を使用してのみ設定可能)	`CERTIFICATE`	`$aws/events/presence/disconnected/clientId`
( AWS CLI/API を使用してのみ設定可能)	`CERTIFICATE`	`$aws/events/subscriptions/subscribed/clientId`
( AWS CLI/API を使用してのみ設定可能)	`CERTIFICATE`	`$aws/events/subscriptions/unsubscribed/clientId`
ジョブ完了、キャンセル済み	`JOB`	`$aws/events/job/jobID/canceled`
ジョブ完了、キャンセル済み	`JOB`	`$aws/events/job/jobID/cancellation_in_progress`
ジョブ完了、キャンセル済み	`JOB`	`$aws/events/job/jobID/completed`
ジョブ完了、キャンセル済み	`JOB`	`$aws/events/job/jobID/deleted`
ジョブ完了、キャンセル済み	`JOB`	`$aws/events/job/jobID/deletion_in_progress`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/canceled`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/deleted`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/failed`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/rejected`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/removed`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/succeeded`
ジョブ実行 : 成功、失敗、拒否、キャンセル、削除	`JOB_EXECUTION`	`$aws/events/jobExecution/jobID/timed_out`
モノ : 作成、更新、削除	`THING`	`$aws/events/thing/thingName/created`
モノ : 作成、更新、削除	`THING`	`$aws/events/thing/thingName/updated`
モノ : 作成、更新、削除	`THING`	`$aws/events/thing/thingName/deleted`
モノグループ : 追加、削除	`THING_GROUP`	`$aws/events/thingGroup/thingGroupName/created`
モノグループ : 追加、削除	`THING_GROUP`	`$aws/events/thingGroup/thingGroupName/updated`
モノグループ : 追加、削除	`THING_GROUP`	`$aws/events/thingGroup/thingGroupName/deleted`
モノグループ階層 : 追加、削除	`THING_GROUP_HIERARCHY`	`$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/added`
モノグループ階層 : 追加、削除	`THING_GROUP_HIERARCHY`	`$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/removed`
モノグループメンバーシップ : 追加、削除	`THING_GROUP_MEMBERSHIP`	`$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/added`
モノグループメンバーシップ : 追加、削除	`THING_GROUP_MEMBERSHIP`	`$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/removed`
モノタイプ : 作成、更新、削除	`THING_TYPE`	`$aws/events/thingType/thingTypeName/created`
モノタイプ : 作成、更新、削除	`THING_TYPE`	`$aws/events/thingType/thingTypeName/updated`
モノタイプ : 作成、更新、削除	`THING_TYPE`	`$aws/events/thingType/thingTypeName/deleted`
モノタイプの関連付け : 追加、削除	`THING_TYPE_ASSOCIATION`	`$aws/events/thingTypeAssociation/thing/thingName/thingType/thingTypeName/added` `$aws/events/thingTypeAssociation/thing/thingName/thingType/thingTypeName/removed`

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

位置ソルバーとデバイスペイロード

登録イベント