予約済みトピック - AWS IoT Core

予約済みトピック

ドル記号 ($) で始まるトピックは AWS IoT 用に予約されています。これらの予約済みトピックは、許可されているとおりにサブスクライブおよび発行できます。ただし、ドル記号で始まる新しいトピックを作成することはできません。予約済みトピックへのサポートされていないパブリッシュまたはサブスクライブオペレーションにより、接続が終了することがあります。

アセットモデルのトピック

トピック クライアントオペレーションを許可する 説明

$aws/sitewise/asset-models/assetModelId/assets/assetId/properties/propertyId

サブスクライブ

AWS IoT SiteWise は、このトピックに対するアセットプロパティ通知をパブリッシュします。詳細については、AWS IoT SiteWise ユーザーガイドの「Interacting with other AWS services」を参照してください。

Device Defender のトピック

これらのメッセージは、トピックのペイロード形式に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript オブジェクト表記 (JSON) 形式のレスポンスバッファをサポートします。

ペイロード形式 レスポンス形式のデータ型
cbor 簡潔なバイナリオブジェクトの表現 (CCOR)
json JavaScript Object Notation (JSON)

詳細については、「」を参照してくださいデバイスからのメトリクスの送信

トピック 許可されている操作 説明

$aws/things/thingName/defender/metrics/payload-format

発行

Device Defender エージェントは、このトピックにメトリクスを発行します。詳細については、「」を参照してくださいデバイスからのメトリクスの送信

$aws/things/thingName/defender/metrics/payload-format/accepted

サブスクライブ

AWS IoT は、Device Defender エージェントが成功したメッセージを $aws/things/thingName/defender/metrics/payload-format に発行した後、このトピックに発行します。詳細については、「」を参照してくださいデバイスからのメトリクスの送信

$aws/things/thingName/defender/metrics/payload-format/rejected

サブスクライブ

AWS IoT は、Device Defender エージェントが失敗したメッセージを $aws/things/thingName/defender/metrics/payload-format に発行した後、このトピックに発行します。詳細については、「」を参照してくださいデバイスからのメトリクスの送信

イベントのトピック

トピック クライアントオペレーションを許可する 説明

$aws/events/certificates/registered/caCertificateId

サブスクライブ

AWS IoT は、AWS IoT が証明書を自動的に登録した時、およびクライアントが PENDING_ACTIVATION ステータスを持つ証明書を提示したときに、このメッセージを発行します。詳細については、「」を参照してください自動登録のためのクライアントによる最初の接続の設定

$aws/events/job/jobID/canceled

サブスクライブ

ジョブがキャンセルされると、AWS IoT はこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/job/jobID/cancellation_in_progress

サブスクライブ

ジョブがキャンセルされるときに、AWS IoT はこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/job/jobID/completed

サブスクライブ

AWS IoT は、ジョブが完了すると、このメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/job/jobID/deleted

サブスクライブ

ジョブが削除されると、AWS IoT はこのメッセージを発行します。詳細については、「ジョブイベント」を参照してください。
$aws/events/job/jobID/deletion_in_progress

サブスクライブ

AWS IoT は、ジョブが削除されるときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/canceled

サブスクライブ

AWS IoT は、ジョブの実行がキャンセルされたときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/deleted

サブスクライブ

AWS IoT は、ジョブの実行が削除されたときに、このメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/failed

サブスクライブ

AWS IoT は、ジョブの実行が失敗したときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/rejected

サブスクライブ

AWS IoT は、ジョブの実行が拒否されたときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/removed

サブスクライブ

AWS IoT は、ジョブの実行が削除されたときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/succeeded

サブスクライブ

AWS IoT は、ジョブの実行が成功すると、このメッセージを発行します。詳細については、「」を参照してくださいジョブイベント
$aws/events/jobExecution/jobID/timed_out

サブスクライブ

AWS IoT は、ジョブの実行がタイムアウトしたときにこのメッセージを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/presence/connected/clientId

サブスクライブ

AWS IoT は、指定クライアント ID を持つ MQTT クライアントが に接続するときにこのトピックにパブリッシュします。AWS IoT詳細については、「」を参照してください接続/切断イベント

$aws/events/presence/disconnected/clientId

サブスクライブ

AWS IoT は、指定クライアント ID を持つ MQTT クライアントが から切断するときにこのトピックにパブリッシュします。AWS IoT詳細については、「」を参照してください接続/切断イベント

$aws/events/subscriptions/subscribed/clientId

サブスクライブ

AWS IoT は、指定クライアント ID を持つ MQTT クライアントが MQTT トピックにサブスクライブするときにこのトピックにパブリッシュします。詳細については、「」を参照してくださいサブスクライブ/サブスクライブ解除イベント

$aws/events/subscriptions/unsubscribed/clientId

サブスクライブ

AWS IoT は、指定クライアント ID を持つ MQTT クライアントが MQTT トピックにサブスクライブ解除するときにこのトピックにパブリッシュします。詳細については、「」を参照してくださいサブスクライブ/サブスクライブ解除イベント

$aws/events/thing/thingName/created

サブスクライブ

AWS IoT は、thingName のモノの作成時にこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thing/thingName/updated

サブスクライブ

AWS IoT は、thingName のモノの更新時にこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thing/thingName/deleted

サブスクライブ

AWS IoT は、thingName のモノが削除されたときにこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingGroup/thingGroupName/created

サブスクライブ

AWS IoT は、thingGroupName が作成されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingGroup/thingGroupName/updated

サブスクライブ

AWS IoT は、thingGroupName が更新されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingGroup/thingGroupName/deleted

サブスクライブ

AWS IoT は、thingGroupName が削除されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingType/thingTypeName/created

サブスクライブ

AWS IoT は、thingTypeName のモノのタイプの作成時にこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingType/thingTypeName/updated

サブスクライブ

AWS IoT は、thingTypeName のモノのタイプの更新時にこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingType/thingTypeName/deleted

サブスクライブ

AWS IoT は、thingTypeName のモノのタイプが削除されたときにこのトピックに発行します。詳細については、「」を参照してください登録イベント

$aws/events/thingTypeAssociation/thing/thingName/thingTypeName

サブスクライブ

AWS IoT は、モノ thingName がモノのタイプ thingTypeName に関連付けられたとき、または関連付けが解除されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

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

サブスクライブ

AWS IoT は、モノ thingName がモノグループ thingGroupName に追加されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

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

サブスクライブ

AWS IoT は、モノ thingName がモノグループ thingGroupName から削除されたときに、このトピックに発行します。詳細については、「」を参照してください登録イベント

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

サブスクライブ

AWS IoT は、モノグループ childThingGroupName がモノグループ parentThingGroupName に追加されたときにこのトピックに発行します。詳細については、「」を参照してください登録イベント

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

サブスクライブ

AWS IoT は、モノグループ childThingGroupName がモノグループ parentThingGroupName から削除されたときにこのトピックに発行します。詳細については、「」を参照してください登録イベント

フリートプロビジョニングのトピック

これらのメッセージは、トピックのペイロード形式に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript オブジェクト表記 (JSON) 形式のレスポンスバッファをサポートします。

ペイロード形式 レスポンス形式のデータ型
cbor 簡潔なバイナリオブジェクトの表現 (CCOR)
json JavaScript Object Notation (JSON)

詳細については、「」を参照してくださいデバイスプロビジョニング MQTT API

トピック クライアントオペレーションを許可する 説明

$aws/certificates/create/payload-format

発行

証明書署名リクエスト (CSR) から証明書を作成するには、このトピックに発行します。

$aws/certificates/create/payload-format/accepted

サブスクライブ

AWS IoT は、$aws/certificates/create/payload-format への呼び出しに成功すると、このトピックに発行します。

$aws/certificates/create/payload-format/rejected

サブスクライブ

AWS IoT は、$aws/certificates/create/payload-format への呼び出しに失敗すると、このトピックに発行します。

$aws/certificates/create-from-csr/payload-format

発行

このトピックに発行して、CSR から証明書を作成します。

$aws/certificates/create-from-csr/payload-format/accepted

サブスクライブ

AWS IoT は、$aws/certificates/create-from-csr/payload-format への成功した呼び出しをこのトピックに発行します。

$aws/certificates/create-from-csr/payload-format/rejected

サブスクライブ

AWS IoT は、$aws/certificates/create-from-csr/payload-format への失敗した呼び出しをこのトピックに発行します。

$aws/events/presence/connected/clientId

サブスクライブ

AWS IoT は、指定クライアント ID を持つ MQTT クライアントが に接続するときにこのトピックにパブリッシュします。AWS IoT詳細については、「」を参照してください接続/切断イベント

$aws/provisioning-templates/templateName/provision/payload-format

発行

モノを登録するには、このトピックに発行します。

$aws/provisioning-templates/templateName/provision/payload-format/accepted

サブスクライブ

AWS IoT は、$aws/provisioning-templates/templateName/provision/payload-format への呼び出しに成功すると、このトピックに発行します。

$aws/provisioning-templates/templateName/provision/payload-format/rejected

サブスクライブ

AWS IoT は、$aws/provisioning-templates/templateName/provision/payload-format への呼び出しに失敗すると、このトピックに発行します。

ジョブのトピック

注記

この表で Receive と記載されているクライアントオペレーションは、クライアントがトピックにサブスクライブしているかどうかに関係なく、リクエストしたクライアントに AWS IoT が直接発行するトピックを示します。クライアントは、サブスクライブしていない場合でも、これらの応答メッセージを受信することを想定すべきです。

これらの応答メッセージはメッセージブローカーを通過せず、他のクライアントまたはルールによってサブスクライブできません。ジョブアクティビティ関連のメッセージをサブスクライブするには、notify および notify-next トピックを使用します。

詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

トピック クライアントオペレーションを許可する 説明

$aws/things/thingName/jobs/get

発行

デバイスは、このトピックにメッセージを発行して、GetPendingJobExecutions リクエストを実行します。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/get/accepted

サブスクライブ、受信

デバイスは、このトピックにサブスクライブして、GetPendingJobExecutions から正常なレスポンスを受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/get/rejected

サブスクライブ、受信

GetPendingJobExecutions リクエストが拒否されると、デバイスはこのトピックにサブスクライブします。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/start-next

発行

デバイスは、このトピックにメッセージを発行して、StartNextPendingJobExecution リクエストを実行します。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/start-next/accepted

サブスクライブ、受信

デバイスは、このトピックにサブスクライブして、StartNextPendingJobExecution リクエストに対する正常なレスポンスを受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/start-next/rejected

サブスクライブ、受信

StartNextPendingJobExecution リクエストが拒否されると、デバイスはこのトピックにサブスクライブします。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/jobId/get

発行

デバイスは、このトピックにメッセージを発行して、DescribeJobExecution リクエストを実行します。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/jobId/get/accepted

サブスクライブ、受信

デバイスは、このトピックにサブスクライブして、DescribeJobExecution リクエストに対する正常なレスポンスを受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/jobId/get/rejected

サブスクライブ、受信

DescribeJobExecution リクエストが拒否されると、デバイスはこのトピックにサブスクライブします。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/jobId/update

発行

デバイスは、このトピックにメッセージをパブリッシュして、UpdateJobExecution リクエストを実行します。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/jobId/update/accepted

サブスクライブ、受信

デバイスは、このトピックにサブスクライブして、UpdateJobExecution リクエストに対する正常なレスポンスを受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

Note

$aws/things/thingName/jobs/jobId/update にパブリッシュするデバイスのみが、このトピックのメッセージを受信します。

$aws/things/thingName/jobs/jobId/update/rejected

サブスクライブ、受信

UpdateJobExecution リクエストが拒否されると、デバイスはこのトピックにサブスクライブします。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

Note

$aws/things/thingName/jobs/jobId/update にパブリッシュするデバイスのみが、このトピックのメッセージを受信します。

$aws/things/thingName/jobs/notify

サブスクライブ

デバイスは、このトピックにサブスクライブして、モノに対して保留中の実行のリストとの間でジョブの実行が追加または削除されたときに、通知を受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/things/thingName/jobs/notify-next

サブスクライブ

デバイスはこのトピックにサブスクライブして、モノに対する次に保留中のジョブの実行が変更されたときに、通知を受け取ります。詳細については、「」を参照してくださいジョブデバイス MQTT/HTTPS API

$aws/events/job/jobId/completed

サブスクライブ

ジョブサービスは、ジョブが完了したときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/job/jobId/canceled

サブスクライブ

ジョブサービスは、ジョブがキャンセルされたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/job/jobId/deleted

サブスクライブ

ジョブサービスは、ジョブが削除されたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/job/jobId/cancellation_in_progress

サブスクライブ

ジョブサービスは、ジョブのキャンセルが開始されたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/job/jobId/deletion_in_progress

サブスクライブ

ジョブサービスは、ジョブの削除が開始されたときに、イベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/succeeded

サブスクライブ

ジョブサービスは、ジョブの実行が成功したときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/failed

サブスクライブ

ジョブサービスは、ジョブの実行が失敗したときにイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/rejected

サブスクライブ

ジョブサービスは、ジョブの実行が拒否されたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/canceled

サブスクライブ

ジョブサービスは、ジョブの実行がキャンセルされたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/timed_out

サブスクライブ

ジョブサービスは、ジョブの実行がタイムアウトしたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/removed

サブスクライブ

ジョブサービスは、ジョブの実行が削除されたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

$aws/events/jobExecution/jobId/deleted

サブスクライブ

ジョブサービスは、ジョブの実行が削除されたときに、このトピックでイベントを発行します。詳細については、「」を参照してくださいジョブイベント

ルールのトピック

トピック クライアントオペレーションを許可する 説明

$aws/rules/ruleName

発行

デバイスまたはアプリケーションは、このトピックに発行して、ルールを直接トリガーします。詳細については、「」を参照してください基本的な取り込みによるメッセージングコストの削減

セキュアトンネリングのトピック

トピック クライアントオペレーションを許可する 説明

$aws/things/thing-name/tunnels/notify

サブスクライブ

AWS IoT は、IoT エージェントがリモートデバイス上でローカルプロキシを開始するために、このメッセージを発行します。詳細については、「」を参照してくださいIoT エージェントスニペット

シャドウトピック

このセクションのトピックは、名前付きシャドウと名前のないシャドウで使用されます。それぞれで使用されるトピックは、トピックのプレフィックスでのみ異なります。この表は、各シャドウタイプで使用されるトピックのプレフィックスを示しています。

ShadowTopicPrefix シャドウタイプ
$aws/things/thingName/shadow 名前のない (クラシック) シャドウ
$aws/things/thingName/shadow/name/shadowName 名前付きシャドウ

完全なトピックを作成するには、次の表に示すように、参照するシャドウのタイプの ShadowTopicPrefix を選択し、thingName と、shadowName (該当する場合) を対応する値に置き換え、トピックスタブに追加します。トピックでは大文字と小文字が区別されることに注意してください。

トピック クライアントオペレーションを許可する 説明

ShadowTopicPrefix/delete

パブリッシュ/サブスクライブ

デバイスまたはアプリケーションは、このトピックにパブリッシュして、シャドウを削除します。詳細については、「/delete」を参照してください。

ShadowTopicPrefix/delete/accepted

サブスクライブ

Device Shadow サービスは、シャドウが削除されると、このトピックにメッセージを送信します。詳細については、「/delete/accepted」を参照してください。

ShadowTopicPrefix/delete/rejected

サブスクライブ

Device Shadow サービスは、シャドウの削除リクエストが拒否されると、このトピックにメッセージを送信します。詳細については、「/delete/rejected」を参照してください。

ShadowTopicPrefix/get

パブリッシュ/サブスクライブ

アプリケーションまたはモノは、このトピックに空のメッセージをパブリッシュして、Shadow を取得します。詳細については、「」を参照してくださいDevice Shadow MQTT トピック

ShadowTopicPrefix/get/accepted

サブスクライブ

Device Shadow サービスは、シャドウに対するリクエストが正常に行われると、このトピックにメッセージを送信します。詳細については、「/get/accepted」を参照してください。

ShadowTopicPrefix/get/rejected

サブスクライブ

Device Shadow サービスは、シャドウのリクエストが拒否されると、このトピックにメッセージを送信します。詳細については、「/get/rejected」を参照してください。

ShadowTopicPrefix/update

パブリッシュ/サブスクライブ

モノまたはアプリケーションは、このトピックにパブリッシュして、Shadow を更新します。詳細については、「/update」を参照してください。

ShadowTopicPrefix/update/accepted

サブスクライブ

Device Shadow サービスは、シャドウに対する更新が正常に行われると、このトピックにメッセージを送信します。詳細については、「/update/accepted」を参照してください。

ShadowTopicPrefix/update/rejected

サブスクライブ

Device Shadow サービスは、シャドウに対する更新が拒否されると、このトピックにメッセージを送信します。詳細については、「/update/rejected」を参照してください。

ShadowTopicPrefix/update/delta

サブスクライブ

Device Shadow サービスは、シャドウの reported セクションと desired セクションとの間で差分が検出されると、このトピックにメッセージを送信します。詳細については、「/update/delta」を参照してください。

ShadowTopicPrefix/update/documents

サブスクライブ

AWS IoT は、Shadow に対する更新が正常に実行されるたびに、このトピックに状態ドキュメントをパブリッシュします。詳細については、「/update/documents」を参照してください。

MQTT ベースのファイル配信のトピック

これらのメッセージは、トピックのペイロード形式に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript オブジェクト表記 (JSON) 形式のレスポンスバッファをサポートします。

ペイロード形式 レスポンス形式のデータ型
cbor 簡潔なバイナリオブジェクトの表現 (CCOR)
json JavaScript Object Notation (JSON)
トピック クライアントオペレーションを許可する 説明

$aws/things/ThingName/streams/StreamId/data/payload-format

サブスクライブ

デバイスからの「GetStream」リクエストが受け入れられた場合、AWS MQTT ベースのファイル配信はこのトピックに発行されます。ペイロードにはストリーミングデータが含まれます。詳細については、「」を参照してくださいデバイスでの AWS IoT MQTT ベースのファイル配信の使用

$aws/things/ThingName/streams/StreamId/get/payload-format

発行

デバイスは、このトピックに発行して、「GetStream」リクエストを実行します。詳細については、「」を参照してくださいデバイスでの AWS IoT MQTT ベースのファイル配信の使用

$aws/things/ThingName/streams/StreamId/description/payload-format

サブスクライブ

デバイスからの「DescribeStream」リクエストが受け入れられた場合、AWS MQTT ベースのファイル配信はこのトピックに発行します。ペイロードには、ストリーミングの説明が含まれます。詳細については、「」を参照してくださいデバイスでの AWS IoT MQTT ベースのファイル配信の使用

$aws/things/ThingName/streams/StreamId/describe/payload-format

発行

デバイスは、このトピックに発行して、「DescribeStream」リクエストを実行します。詳細については、「」を参照してくださいデバイスでの AWS IoT MQTT ベースのファイル配信の使用

$aws/things/ThingName/streams/StreamId/rejected/payload-format

サブスクライブ

デバイスからの「DescribeStream」または「GetStream」リクエストが拒否された場合、AWS MQTT ベースのファイル配信はこのトピックに発行されます。詳細については、「」を参照してくださいデバイスでの AWS IoT MQTT ベースのファイル配信の使用

予約済みトピック ARN

すべての予約済みトピック ARN (Amazon リソースネーム) は、次の形式です。

arn:aws:iot:aws-region:AWS-account-ID:topic/Topic

例えば、arn:aws:iot:us-west-2:123EXAMPLE456:topic/$aws/things/thingName/jobs/get/accepted は予約済みトピック $aws/things/thingName/jobs/get/accepted の ARN です。