予約済みトピック - AWS IoT コア

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

予約済みトピック

ドル記号 ($) で始まるトピックは AWS IoT 用に予約されています。You can subscribe and publish to these reserved topics as they allow; however, you can't create new topics that begin with a dollar sign. 予約済みトピックへのサポートされていないパブリッシュまたはサブスクライブオペレーションにより、接続が終了することがあります。

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

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

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

サブスクライブ

AWS IoT SiteWise は、このトピックに対するアセットプロパティ通知をパブリッシュします。For more information, see Interacting with other AWS services in the AWS IoT SiteWise ユーザーガイド.

Device Defender のトピック

These messages support response buffers in Concise Binary Object Representation (CBOR) format and JavaScript Object Notation (JSON), depending on the payload-format of the topic.

payload-format レスポンス形式のデータ型
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 publishes to this topic after a Device Defender agent publishes a successful message to $aws/things/thingName/defender/metrics/payload-format詳細については、「デバイスからのメトリクスの送信」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic after a Device Defender agent publishes an unsuccessful message to $aws/things/thingName/defender/metrics/payload-format詳細については、「デバイスからのメトリクスの送信」を参照してください。

イベントのトピック

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

$aws/events/certificates/registered/caCertificateId

サブスクライブ

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

$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 publishes to this topic when the thingName thing is created. 詳細については、「登録イベント」を参照してください。

$aws/events/thing/thingName/updated

サブスクライブ

AWS IoT publishes to this topic when the thingName thing is updated. 詳細については、「登録イベント」を参照してください。

$aws/events/thing/thingName/deleted

サブスクライブ

AWS IoT publishes to this topic when the thingName thing is deleted. 詳細については、「登録イベント」を参照してください。

$aws/events/thingGroup/thingGroupName/created

サブスクライブ

AWS IoT publishes to this topic when thing group,thingGroupName, is created. 詳細については、「登録イベント」を参照してください。

$aws/events/thingGroup/thingGroupName/updated

サブスクライブ

AWS IoT publishes to this topic when thing group,thingGroupName, is updated. 詳細については、「登録イベント」を参照してください。

$aws/events/thingGroup/thingGroupName/deleted

サブスクライブ

AWS IoT publishes to this topic when thing group,thingGroupName, is deleted. 詳細については、「登録イベント」を参照してください。

$aws/events/thingType/thingTypeName/created

サブスクライブ

AWS IoT publishes to this topic when the thingTypeName thing type is created. 詳細については、「登録イベント」を参照してください。

$aws/events/thingType/thingTypeName/updated

サブスクライブ

AWS IoT publishes to this topic when the thingTypeName thing type is updated. 詳細については、「登録イベント」を参照してください。

$aws/events/thingType/thingTypeName/deleted

サブスクライブ

AWS IoT publishes to this topic when the thingTypeName thing type is deleted. 詳細については、「登録イベント」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic when thing,thingName, is associated with or disassociated from thing type,thingTypeName詳細については、「登録イベント」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic when thing,thingName, is added to thing group,thingGroupName詳細については、「登録イベント」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic when thing,thingName, is removed from thing group,thingGroupName詳細については、「登録イベント」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic when thing group,childThingGroupName, is added to thing group,parentThingGroupName詳細については、「登録イベント」を参照してください。

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

サブスクライブ

AWS IoT publishes to this topic when thing group,childThingGroupName, is removed from thing group,parentThingGroupName詳細については、「登録イベント」を参照してください。

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

These messages support response buffers in Concise Binary Object Representation (CBOR) format and JavaScript Object Notation (JSON), depending on the payload-format of the topic.

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

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

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

$aws/certificates/create/payload-format

発行

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

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

サブスクライブ

AWS IoT publishes to this topic after a successful call to $aws/certificates/create/payload-format.

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

サブスクライブ

AWS IoT publishes to this topic after an unsuccessful call to $aws/certificates/create/payload-format.

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

発行

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

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

サブスクライブ

AWS IoT publishes to this topic a successful call to $aws/certificates/create-from-csr/payload-format.

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

サブスクライブ

AWS IoT publishes to this topic an unsuccessful call to $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 publishes to this topic after a successful call to $aws/provisioning-templates/templateName/provision/payload-format.

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

サブスクライブ

AWS IoT publishes to this topic after an unsuccessful call to $aws/provisioning-templates/templateName/provision/payload-format.

ジョブのトピック

注記

The client operations noted as Receive in this table indicate topics that AWS IoT publishes to clients whether the client has subscribed to the topic or not. Clients should expect to receive these messages even if they have not subscribed to them. 詳細については、「ジョブデバイス MQTT および HTTPSAPIs」を参照してください。

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

$aws/things/thingName/jobs/get

発行

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

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

Subscribe, Receive

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

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

Subscribe, Receive

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

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

発行

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

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

Subscribe, Receive

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

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

Subscribe, Receive

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

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

発行

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

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

Subscribe, Receive

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

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

Subscribe, Receive

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

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

発行

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

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

Subscribe, Receive

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

Note

Only the device that publishes to $aws/things/thingName/jobs/jobId/update receives messages on this topic.

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

Subscribe, Receive

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

Note

Only the device that publishes to $aws/things/thingName/jobs/jobId/update receives messages on this topic.

$aws/things/thingName/jobs/notify

サブスクライブ

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

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

サブスクライブ

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

$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 publishes this message for an IoT agent to start a local proxy on the remote device. 詳細については、「IoT エージェントスニペット」を参照してください。

シャドウトピック

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

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

To create a complete topic, select the ShadowTopicPrefix for the type of shadow to which you want to refer, replace thingName and if applicable,shadowName, with their corresponding values, and then append that with the topic stub as shown in the following table. トピックでは大文字と小文字が区別されることに注意してください。

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

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」を参照してください。

Streaming service topics

These messages support response buffers in Concise Binary Object Representation (CBOR) format and JavaScript Object Notation (JSON), depending on the payload-format of the topic.

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

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

サブスクライブ

The AWS Streaming service publishes to this topic if the "GetStream" request from a device is accepted. The payload contains the stream data. For more information, see Using the Streaming service in devices.

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

発行

A device publishes to this topic to perform a "GetStream" request. For more information, see Using the Streaming service in devices.

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

サブスクライブ

The AWS Streaming service publishes to this topic if the "DescribeStream" request from a device is accepted. The payload contains the stream description. For more information, see Using the Streaming service in devices.

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

発行

A device publishes to this topic to perform a "DescribeStream" request. For more information, see Using the Streaming service in devices.

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

サブスクライブ

The AWS Streaming service publishes to this topic if a "DescribeStream" or "GetStream" request from a device is rejected. For more information, see Using the Streaming service in devices.

Troubleshooting "Stream limit exceeded for your AWS account"

The OTA Update Manager Service can create a stream on your behalf. So, if you see "Error: You have exceeded the limit for the number of streams in your AWS account.", you can clean up the unused streams in your account instead of requesting a limit increase.

未使用ストリームをクリーンアップするには、次のコマンドを使用します。

OTA 更新マネージャーサービスによって作成されたストリームの場合:

aws iot delete-ota-update –ota-update-id value --delete-stream

詳細については、「delete-ota-update」を参照してください。

AWS CLI または SDK を使用して作成したストリームの場合:

aws iot delete-stream –stream-id value

詳細については、「delete-stream」を参照してください。

注記

OTA 更新 ID またはストリーム ID は、list-ota-updates コマンドまたは list-streams コマンドを使用して検索できます。

Also, be aware that because the OTA Cloud service accesses S3 object metadata in your AWS account on your behalf, this might generate a cost on your bill. 詳細については、「Amazon S3 の料金」を参照してください。

Reserved topic ARN

All reserved topic ARNs (Amazon Resource Names) have the following form:

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

For example, arn:aws:iot:us-west-2:123EXAMPLE456:topic/$aws/things/thingName/jobs/get/accepted is an ARN for the reserved topic $aws/things/thingName/jobs/get/accepted.