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

英語の翻訳が提供されている場合で、内容が矛盾する場合には、英語版がオリジナルとして取り扱われます。翻訳は機械翻訳により提供されています。

予約済みトピック

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

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

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

$aws/現場/資産モデル/assetModelId/資産/assetIdプロパティpropertyId

サブスクライブ

AWS IoT SiteWise は、このトピックに対するアセットプロパティ通知をパブリッシュします。詳細については、以下を参照してください。 他者との交流 AWS サービスAWS IoT SiteWise ユーザーガイド.

Device Defender のトピック

これらのメッセージは、payload-format 話します

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

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

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

$aws/モノ/thingName/ディフェンダー/メトリックス/payload-format

発行

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

$aws/モノ/thingName/ディフェンダー/メトリックス/payload-format/承認済み

サブスクライブ

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

$aws/モノ/thingName/ディフェンダー/メトリックス/payload-format/拒否済み

サブスクライブ

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

イベントのトピック

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

$aws/イベント/サーティフィケート/登録/caCertificateId

サブスクライブ

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

$aws/イベント/プレゼンス/コネクテッド/clientId

サブスクライブ

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

$aws/events/プレゼンス/切断/clientId

サブスクライブ

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

$aws/events/subscriptions/subscribed/(aws/イベント/購読)clientId

サブスクライブ

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

$aws/events/subscriptions/unsubscribed/(aws/イベント/購読/購読解除)clientId

サブスクライブ

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

$aws/イベント/thing/thingName作成済み

サブスクライブ

AWS IoT このトピックは、thingName 生み出されます。詳細については、登録イベント を参照してください。

$aws/イベント/thing/thingNameupdated

サブスクライブ

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

$aws/イベント/thing/thingName/削除済み

サブスクライブ

AWS IoT このトピックは、thingName 削除します。詳細については、登録イベント を参照してください。

$aws/イベント/thingGroup/thingGroupName作成済み

サブスクライブ

AWS IoT このトピックに公開する thingGroupName、が作成されます。詳細については、登録イベント を参照してください。

$aws/イベント/thingGroup/thingGroupNameupdated

サブスクライブ

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

$aws/イベント/thingGroup/thingGroupName/削除済み

サブスクライブ

AWS IoT このトピックに公開する thingGroupNameは削除されます。詳細については、登録イベント を参照してください。

$aws/イベント/thingType/thingTypeName作成済み

サブスクライブ

AWS IoT このトピックは、thingTypeName 作成されています。詳細については、登録イベント を参照してください。

$aws/イベント/thingType/thingTypeNameupdated

サブスクライブ

AWS IoT このトピックは、thingTypeName 更新されています。詳細については、登録イベント を参照してください。

$aws/イベント/thingType/thingTypeName/削除済み

サブスクライブ

AWS IoT このトピックは、thingTypeName 削除します。詳細については、登録イベント を参照してください。

$aws/events/thingType関連付け/thing/thingName/thingTypeName

サブスクライブ

AWS IoT このトピックを公開します。thingNameは、品目タイプに関連または関連解除されています。thingTypeName詳細については、登録イベント を参照してください。

$aws/events/thingGroupMembership/thingGroup/thingGroupNamethingthingName/追加済み

サブスクライブ

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

$aws/events/thingGroupMembership/thingGroup/thingGroupNamethingthingName削除済み

サブスクライブ

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

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/追加済み

サブスクライブ

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

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName削除済み

サブスクライブ

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

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

これらのメッセージは、payload-format 話します

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

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

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

$aws/証明書/作成/payload-format

発行

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

$aws/証明書/作成/payload-format/承認済み

サブスクライブ

AWS IoT $aws/certificates/create/への呼び出しが成功した後、はこのトピックに公開します。payload-format.

$aws/証明書/作成/payload-format/拒否済み

サブスクライブ

AWS IoT $aws/certificates/create/への呼び出しに失敗した後、はこのトピックに公開します。payload-format.

$aws/証明書/create-from-csr/payload-format

発行

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

$aws/証明書/create-from-csr/payload-format/承認済み

サブスクライブ

AWS IoT $aws/certificates/create-from-csr/への呼び出しが成功しましたpayload-format.

$aws/証明書/create-from-csr/payload-format/拒否済み

サブスクライブ

AWS IoT $aws/certificates/create-from-csr/への呼び出しが失敗したことをこのトピックに公開します。payload-format.

$aws/イベント/プレゼンス/コネクテッド/clientId

サブスクライブ

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

$aws/プロビジョニング-テンプレート/templateName/プロビジョニング/payload-format

発行

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

$aws/プロビジョニング-テンプレート/templateName/プロビジョニング/payload-format/承認済み

サブスクライブ

AWS IoT $aws/プロビジョニングテンプレート/templateName/プロビジョニング/payload-format.

$aws/プロビジョニング-テンプレート/templateName/プロビジョニング/payload-format/拒否済み

サブスクライブ

AWS IoT $aws/provisioning-templates/への呼び出しが失敗した後に、このトピックにを公開します。templateName/プロビジョニング/payload-format.

ジョブのトピック

注記

クライアント操作は次のように記されています。 受信 この表には、 AWS IoT クライアントがトピックを購読しているかどうかにかかわらず、クライアントに公開されます。お客様は、購読していない場合でも、これらのメッセージを受信できることを期待する必要があります。詳細については、ジョブデバイス MQTT/HTTPS API を参照してください。

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

$aws/モノ/thingName/ジョブ/ゲット

発行

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

$aws/モノ/thingName/ジョブ/取得/承認

購読、受信

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

$aws/モノ/thingName/ジョブ/取得/拒否

購読、受信

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

$aws/モノ/thingName/ジョブ/次のスタート

発行

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

$aws/モノ/thingName/ジョブ/スタート-ネクスト/受理

購読、受信

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

$aws/モノ/thingName/jobs/start-next/拒否

購読、受信

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

$aws/モノ/thingNamejobs/jobIdget

発行

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

$aws/モノ/thingNamejobs/jobId/get/accepted

購読、受信

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

$aws/モノ/thingNamejobs/jobId/get/rejected

購読、受信

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

$aws/モノ/thingNamejobs/jobIdupdate

発行

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

$aws/モノ/thingNamejobs/jobId/update/accepted

購読、受信

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

Note

$aws/things/に公開するデバイスのみthingNamejobs/jobId/update はこのトピックに関するメッセージを受信します。

$aws/モノ/thingNamejobs/jobId/update/rejected

購読、受信

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

Note

$aws/things/に公開するデバイスのみthingNamejobs/jobId/update はこのトピックに関するメッセージを受信します。

$aws/モノ/thingName/ジョブ/通知

サブスクライブ

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

$aws/モノ/thingName/職務/通知-次へ

サブスクライブ

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

$aws/イベント/ジョブ/jobId完了

サブスクライブ

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

$aws/イベント/ジョブ/jobId/キャンセル済み

サブスクライブ

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

$aws/イベント/ジョブ/jobId/削除済み

サブスクライブ

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

$aws/イベント/ジョブ/jobId/進行中のキャンセル

サブスクライブ

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

$aws/イベント/ジョブ/jobId/削除_進行中

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId/成功

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId失敗

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId/拒否済み

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId/キャンセル済み

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId/timed_out(タイムアウト)

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId削除済み

サブスクライブ

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

$aws/イベント/ジョブ実行/jobId/削除済み

サブスクライブ

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

ルールのトピック

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

$aws/ルール/ruleName

発行

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

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

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

$aws/モノ/thing-name/トンネル/通知

サブスクライブ

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

シャドウトピック

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

ShadowTopicPrefix value シャドウタイプ
$aws/モノ/thingNameシャドウ 名前のない (クラシック) シャドウ
$aws/モノ/thingName/シャドー/名前/shadowName 名前付きシャドウ

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

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

ShadowTopicPrefixdelete

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

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

ShadowTopicPrefix/delete/accepted

サブスクライブ

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

ShadowTopicPrefix/delete/rejected

サブスクライブ

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

ShadowTopicPrefixget

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

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

ShadowTopicPrefix/get/accepted

サブスクライブ

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

ShadowTopicPrefix/get/rejected

サブスクライブ

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

ShadowTopicPrefixupdate

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

モノまたはアプリケーションは、このトピックにパブリッシュして、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」を参照してください。

予約トピック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 は予約トピックのARNです $aws/things/thingName/jobs/get/accepted.