予約済みトピック
ドル記号 ($) で始まるトピックは AWS IoT 用に予約されています。これらの予約済みトピックは、許可されているとおりにサブスクライブおよび発行できます。ただし、ドル記号で始まる新しいトピックを作成することはできません。予約済みトピックへのサポートされていないパブリッシュまたはサブスクライブオペレーションにより、接続が終了することがあります。
アセットモデルのトピック
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/sitewise/asset-models/ |
サブスクライブ |
AWS IoT SiteWise は、このトピックに対するアセットプロパティ通知をパブリッシュします。詳細については、AWS IoT SiteWise ユーザーガイドの「Interacting with other AWS services」を参照してください。 |
Device Defender のトピック
これらのメッセージは、トピックのペイロード形式
に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript Object Notation (JSON) 形式のレスポンスバッファをサポートします。
ペイロード形式 |
レスポンス形式のデータ型 |
---|---|
cbor | 簡潔なバイナリオブジェクトの表現 (CCOR) |
json | JavaScript Object Notation (JSON) |
詳細については、「デバイスからのメトリクスの送信」を参照してください。
トピック | 許可されている操作 | 説明 |
---|---|---|
$aws/things/ |
発行 |
Device Defender エージェントは、このトピックにメトリクスを発行します。詳細については、「デバイスからのメトリクスの送信」を参照してください。 |
$aws/things/ |
サブスクライブ |
AWS IoT は、Device Defender エージェントが成功したメッセージを $aws/things/ |
$aws/things/ |
サブスクライブ |
AWS IoT は、Device Defender エージェントが失敗したメッセージを $aws/things/ |
イベントのトピック
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/events/certificates/registered/ |
サブスクライブ |
AWS IoT は、AWS IoT が証明書を自動的に登録した時、およびクライアントが |
$aws/events/job/ |
サブスクライブ |
ジョブがキャンセルされると、AWS IoT はこのメッセージを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/jobID /cancellation_in_progress |
サブスクライブ |
ジョブがキャンセルされるときに、AWS IoT はこのメッセージを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
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/ |
サブスクライブ |
AWS IoT は、指定クライアント ID を持つ MQTT クライアントが に接続するときにこのトピックにパブリッシュします。AWS IoT詳細については、「接続/切断イベント」を参照してください。 |
$aws/events/presence/disconnected/ |
サブスクライブ |
AWS IoT は、指定クライアント ID を持つ MQTT クライアントが から切断するときにこのトピックにパブリッシュします。AWS IoT詳細については、「接続/切断イベント」を参照してください。 |
$aws/events/subscriptions/subscribed/ |
サブスクライブ |
AWS IoT は、指定クライアント ID を持つ MQTT クライアントが MQTT トピックにサブスクライブするときにこのトピックにパブリッシュします。詳細については、「サブスクライブ/サブスクライブ解除イベント」を参照してください。 |
$aws/events/subscriptions/unsubscribed/ |
サブスクライブ |
AWS IoT は、指定クライアント ID を持つ MQTT クライアントが MQTT トピックにサブスクライブ解除するときにこのトピックにパブリッシュします。詳細については、「サブスクライブ/サブスクライブ解除イベント」を参照してください。 |
$aws/events/thing/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thing/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thing/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingGroup/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingGroup/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingGroup/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingType/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingType/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingType/ |
サブスクライブ |
AWS IoT は、 |
$aws/events/thingTypeAssociation/thing/ |
サブスクライブ |
AWS IoT は、モノ |
$aws/events/thingGroupMembership/thingGroup/ |
サブスクライブ |
AWS IoT は、モノ |
$aws/events/thingGroupMembership/thingGroup/ |
サブスクライブ |
AWS IoT は、モノ |
$aws/events/thingGroupHierarchy/thingGroup/ |
サブスクライブ |
AWS IoT は、モノグループ |
$aws/events/thingGroupHierarchy/thingGroup/ |
サブスクライブ |
AWS IoT は、モノグループ |
フリートプロビジョニングのトピック
これらのメッセージは、トピックのペイロード形式
に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript Object Notation (JSON) 形式のレスポンスバッファをサポートします。
ペイロード形式 |
レスポンス形式のデータ型 |
---|---|
cbor | 簡潔なバイナリオブジェクトの表現 (CCOR) |
json | JavaScript Object Notation (JSON) |
詳細については、「デバイスプロビジョニング MQTT API」を参照してください。
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/certificates/create/ |
発行 |
証明書署名リクエスト (CSR) から証明書を作成するには、このトピックに発行します。 |
$aws/certificates/create/ |
サブスクライブ |
AWS IoT は、$aws/certificates/create/ |
$aws/certificates/create/ |
サブスクライブ |
AWS IoT は、$aws/certificates/create/ |
$aws/certificates/create-from-csr/ |
発行 |
このトピックに発行して、CSR から証明書を作成します。 |
$aws/certificates/create-from-csr/ |
サブスクライブ |
AWS IoT は、$aws/certificates/create-from-csr/ |
$aws/certificates/create-from-csr/ |
サブスクライブ |
AWS IoT は、$aws/certificates/create-from-csr/ |
$aws/events/presence/connected/ |
サブスクライブ |
AWS IoT は、指定クライアント ID を持つ MQTT クライアントが に接続するときにこのトピックにパブリッシュします。AWS IoT詳細については、「接続/切断イベント」を参照してください。 |
$aws/provisioning-templates/ |
発行 |
モノを登録するには、このトピックに発行します。 |
$aws/provisioning-templates/ |
サブスクライブ |
AWS IoT は、$aws/provisioning-templates/ |
$aws/provisioning-templates/ |
サブスクライブ |
AWS IoT は、$aws/provisioning-templates/ |
ジョブのトピック
この表で Receive と記載されているクライアントオペレーションは、クライアントがトピックにサブスクライブしているかどうかに関係なく、リクエストしたクライアントに AWS IoT が直接発行するトピックを示します。クライアントは、応答メッセージにサブスクライブしていない場合でも、それらを受信する場合があることを想定する必要があります。
これらの応答メッセージはメッセージブローカーを通過せず、他のクライアントまたはルールによってサブスクライブする事はできません。ジョブアクティビティ関連のメッセージをサブスクライブするには、notify
および notify-next
トピックを使用します。
ジョブとjobExecution
フリートモニタリングソリューション用のイベントトピックをサブスクライブする際は、まずジョブおよびジョブイベントを実行して、クラウド側でイベント受信する必要があります。
詳細については、「ジョブデバイス MQTT API」を参照してください。
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/things/ |
発行 |
デバイスは、このトピックにメッセージを発行して、 |
$aws/things/ |
サブスクライブ、受信 |
デバイスは、このトピックにサブスクライブして、 |
$aws/things/ |
サブスクライブ、受信 |
|
$aws/things/ |
発行 |
デバイスは、このトピックにメッセージを発行して、 |
$aws/things/ |
サブスクライブ、受信 |
デバイスは、このトピックをサブスクライブして、 |
$aws/things/ |
サブスクライブ、受信 |
|
$aws/things/ |
発行 |
デバイスは、このトピックにメッセージを発行して、 |
$aws/things/ |
サブスクライブ、受信 |
デバイスは、このトピックをサブスクライブして、 |
$aws/things/ |
サブスクライブ、受信 |
|
$aws/things/ |
発行 |
デバイスは、このトピックにメッセージをパブリッシュして、 |
$aws/things/ |
サブスクライブ、受信 |
デバイスは、このトピックにサブスクライブして、 $aws/things/ |
$aws/things/ |
サブスクライブ、受信 |
$aws/things/ |
$aws/things/ |
サブスクライブ |
デバイスは、このトピックにサブスクライブして、モノに対して保留中の実行のリストとの間でジョブの実行が追加または削除されたときに、通知を受け取ります。詳細については、「ジョブデバイス MQTT API」を参照してください。 |
$aws/things/ |
サブスクライブ |
デバイスはこのトピックにサブスクライブして、モノに対する次に保留中のジョブの実行が変更されたときに、通知を受け取ります。詳細については、「ジョブデバイス MQTT API」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
ジョブサービスは、ジョブが完了したときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
ジョブサービスは、ジョブがキャンセルされたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
ジョブサービスは、ジョブが削除されたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
ジョブサービスは、ジョブのキャンセルが開始されたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/job/ |
サブスクライブ |
ジョブサービスは、ジョブの削除が開始されたときに、イベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行が成功したときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行が失敗したときにイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行が拒否されたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行がキャンセルされたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行がタイムアウトしたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行が削除されたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
$aws/events/jobExecution/ |
サブスクライブ |
ジョブサービスは、ジョブの実行が削除されたときに、このトピックでイベントを発行します。詳細については、「ジョブイベント」を参照してください。 |
ルールのトピック
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/rules/ |
発行 |
デバイスまたはアプリケーションは、このトピックに発行して、ルールを直接トリガーします。詳細については、「基本的な取り込みによるメッセージングコストの削減」を参照してください。 |
セキュアトンネリングのトピック
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/things/ |
サブスクライブ |
AWS IoT は、IoT エージェントがリモートデバイス上でローカルプロキシを開始するために、このメッセージを発行します。詳細については、「IoT エージェントスニペット」を参照してください。 |
シャドウトピック
このセクションのトピックは、名前付きシャドウと名前のないシャドウで使用されます。それぞれで使用されるトピックは、トピックのプレフィックスでのみ異なります。この表は、各シャドウタイプで使用されるトピックのプレフィックスを示しています。
ShadowTopicPrefix 値 |
シャドウタイプ |
---|---|
$aws/things/thingName /shadow |
名前のない (クラシック) シャドウ |
$aws/things/thingName /shadow/name/shadowName |
名前付きシャドウ |
完全なトピックを作成するには、次の表に示すように、参照するシャドウのタイプの ShadowTopicPrefix
を選択し、thingName
と、shadowName
(該当する場合) を対応する値に置き換え、トピックスタブに追加します。トピックでは大文字と小文字が区別されることに注意してください。
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
|
パブリッシュ/サブスクライブ |
デバイスまたはアプリケーションは、このトピックにパブリッシュして、シャドウを削除します。詳細については、「/delete」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウが削除されると、このトピックにメッセージを送信します。詳細については、「/delete/accepted」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウの削除リクエストが拒否されると、このトピックにメッセージを送信します。詳細については、「/delete/rejected」を参照してください。 |
|
パブリッシュ/サブスクライブ |
アプリケーションまたはモノは、このトピックに空のメッセージをパブリッシュして、Shadow を取得します。詳細については、「Device Shadow MQTT トピック」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウに対するリクエストが正常に行われると、このトピックにメッセージを送信します。詳細については、「/get/accepted」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウのリクエストが拒否されると、このトピックにメッセージを送信します。詳細については、「/get/rejected」を参照してください。 |
|
パブリッシュ/サブスクライブ |
モノまたはアプリケーションは、このトピックにパブリッシュして、Shadow を更新します。詳細については、「/update」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウに対する更新が正常に行われると、このトピックにメッセージを送信します。詳細については、「/update/accepted」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウに対する更新が拒否されると、このトピックにメッセージを送信します。詳細については、「/update/rejected」を参照してください。 |
|
サブスクライブ |
Device Shadow サービスは、シャドウの reported セクションと desired セクションとの間で差分が検出されると、このトピックにメッセージを送信します。詳細については、「/update/delta」を参照してください。 |
|
サブスクライブ |
AWS IoT は、Shadow に対する更新が正常に実行されるたびに、このトピックに状態ドキュメントをパブリッシュします。詳細については、「/update/documents」を参照してください。 |
MQTT ベースのファイル配信のトピック
これらのメッセージは、トピックのペイロード形式
に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript Object Notation (JSON) 形式のレスポンスバッファをサポートします。
ペイロード形式 |
レスポンス形式のデータ型 |
---|---|
cbor | 簡潔なバイナリオブジェクトの表現 (CCOR) |
json | JavaScript Object Notation (JSON) |
トピック | クライアントオペレーションを許可する | 説明 |
---|---|---|
$aws/things/ |
サブスクライブ |
デバイスからの「GetStream」リクエストが受け入れられた場合、AWS MQTT ベースのファイル配信はこのトピックに発行されます。ペイロードにはストリーミングデータが含まれます。詳細については、「デバイスでの AWS IoT MQTT ベースのファイル配信の使用」を参照してください。 |
$aws/things/ |
発行 |
デバイスは、このトピックに発行して、「GetStream」リクエストを実行します。詳細については、「デバイスでの AWS IoT MQTT ベースのファイル配信の使用」を参照してください。 |
$aws/things/ |
サブスクライブ |
デバイスからの「DescribeStream」リクエストが受け入れられた場合、AWS MQTT ベースのファイル配信はこのトピックに発行します。ペイロードには、ストリーミングの説明が含まれます。詳細については、「デバイスでの AWS IoT MQTT ベースのファイル配信の使用」を参照してください。 |
$aws/things/ |
発行 |
デバイスは、このトピックに発行して、「DescribeStream」リクエストを実行します。詳細については、「デバイスでの AWS IoT MQTT ベースのファイル配信の使用」を参照してください。 |
$aws/things/ |
サブスクライブ |
デバイスからの「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 です。