View a markdown version of this page

保留的主题 - AWS IoT Core
资产模型主题AWS IoT Device Defender 主题AWS IoT Core 设备位置主题事件主题队列预调配主题任务主题命令主题规则主题安全隧道主题影子主题MQTT-based 文件交付主题保留的主题 ARN

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

保留的主题

以美元符号 ($) 开头的主题保留供使用 AWS IoT。您可以在允许的情况下订阅和发布到这些保留的主题；但是，您不能创建以美元符号开头的新主题。对保留的主题执行不受支持的发布或订阅操作可能会导致连接终止。

资产模型主题

Topic 允许的客户端操作 说明

$ aws/sitewise /资产模型/ /资产//assetModelId属性/ assetId propertyId

Subscribe

AWS IoT SiteWise 发布此主题的资产属性通知。有关更多信息，请参阅《AWS IoT SiteWise 用户指南》中的与其他 AWS 服务交互。

AWS IoT Device Defender 主题

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区，具体取决于payload-format主题。 AWS IoT Device Defender 主题仅支持 MQTT 发布。

payload-format 响应格式数据类型
cbor 简洁二进制对象表示法 (CBOR)
json JavaScript 对象表示法 (JSON)

有关更多信息，请参阅从设备发送指标。

Topic 允许的操作 说明

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

发布

AWS IoT Device Defender 代理发布此主题的指标。有关更多信息，请参阅从设备发送指标。

$aws/things//thingNamedefender/metrics/payload-format/已接受

Subscribe

AWS IoT AWS IoT Device Defender 代理向 $aws/things//thingNamedefender/metrics/发布成功的消息后，将发布到此主题payload-format。有关更多信息，请参阅从设备发送指标。

$aws/things//thingNamedefender/metrics/payload-format/已拒绝

Subscribe

AWS IoT AWS IoT Device Defender 代理向 $aws/things//thingNamedefender/metrics/发布失败的消息后发布到此主题payload-format。有关更多信息，请参阅从设备发送指标。

AWS IoT Core 设备位置主题

AWS IoT Core 设备位置可以解析来自设备的测量数据，并提供物联网设备的估计位置。来自设备的测量数据可以包括 GNSS Wi-Fi、蜂窝和 IP 地址。 AWS IoT Core 然后，设备定位选择可提供最佳精度并求解设备位置信息的测量类型。有关更多信息，请参阅AWS IoT Core 设备位置和使用解析设备位置 AWS IoT Core 设备位置 MQTT 主题。

Topic 允许的操作 说明

$aws/device_location/customer_device_id/获取位置估计

发布

设备发布到此主题以获取扫描的原始测量数据，以通过 “ AWS IoT Core 设备位置” 进行解析。

$aws/device_location/customer_device_id/get_position_estimate/accepted

Subscribe

AWS IoT Core 设备位置成功解析设备位置后，将发布到此主题。

$aws/device_location/customer_device_id/get_position_estimate/rejected

Subscribe

AWS IoT Core 当设备位置由于 4xx 错误而无法成功解析设备位置时，将发布到此主题。

事件主题

在发生特定事件时将发布事件消息。例如，在添加、更新或删除事物时，由注册表生成事件。该表显示了各种 AWS IoT 活动及其保留主题。

Topic 允许的客户端操作 说明

$aws/events/certificates/registered/caCertificateId

Subscribe

AWS IoT 当 AWS IoT 自动注册证书以及客户端出示带有该PENDING_ACTIVATION状态的证书时，会发布此消息。有关更多信息，请参阅 配置客户端的首次连接以进行自动注册。

$ aws/events /job//jobID已取消

Subscribe

 AWS IoT 取消任务时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /job/ /cancellation_in_progress jobID

Subscribe

 AWS IoT 在取消任务时发布此消息。有关更多信息，请参阅 任务事件。

$ aws/events /job//jobID已完成

Subscribe

 AWS IoT 任务完成后发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /job//jobID已删除

Subscribe

 AWS IoT 删除任务时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /job/ /deletion_in_progress jobID

Subscribe

 AWS IoT 在删除任务时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution//jobID已取消

Subscribe

 AWS IoT 取消任务执行时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution//jobID已删除

Subscribe

 AWS IoT 删除任务执行时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution/ /失败 jobID

Subscribe

 AWS IoT 任务执行失败时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution//jobID已拒绝

Subscribe

 AWS IoT 在任务执行被拒绝时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution//jobID已移除

Subscribe

 AWS IoT 删除任务执行时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution/ /成功 jobID

Subscribe

 AWS IoT 任务执行成功时发布此消息。有关更多信息，请参阅 任务事件。
$ aws/events /jobExecution//jobIDtimed_out

Subscribe

 AWS IoT 任务执行超时时发布此消息。有关更多信息，请参阅 任务事件。

$aws/events/presence/connected/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的 MQTT 客户端连接到时，将发布到 AWS IoT此主题。有关更多信息，请参阅 Connect/Disconnect 事件。

$aws/events/presence/disconnected/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的 MQTT 客户端断开连接时，将发布到此主题。 AWS IoT有关更多信息，请参阅 Connect/Disconnect 事件。

$aws/events/subscriptions/subscribed/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的 MQTT 客户端订阅 MQTT 主题时，将发布到此主题。有关更多信息，请参阅 Subscribe/Unsubscribe 事件。

$aws/events/subscriptions/unsubscribed/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的 MQTT 客户端取消订阅 MQTT 主题时，将发布到此主题。有关更多信息，请参阅 Subscribe/Unsubscribe 事件。

$ aws/events /thing//thingName已创建

Subscribe

AWS IoT 创建thingName事物时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /thing//thingName已更新

Subscribe

AWS IoT 当thingName事物更新时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /thing//thingName已删除

Subscribe

AWS IoT 当thingName事物被删除后，将发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /ThingGroup//thingGroupName已创建

Subscribe

AWS IoT 创建事物组thingGroupName时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /ThingGroup//thingGroupName已更新

Subscribe

AWS IoT 更新事物组thingGroupName时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /ThingGroup//thingGroupName已删除

Subscribe

AWS IoT 删除事物组thingGroupName时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /thingType//thingTypeName已创建

Subscribe

AWS IoT 创建thingTypeName事物类型时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /thingType//thingTypeName已更新

Subscribe

AWS IoT 更新thingTypeName事物类型时发布到此主题。有关更多信息，请参阅 注册表事件。

$ aws/events /thingType//thingTypeName已删除

Subscribe

AWS IoT 删除thingTypeName事物类型后发布到此主题。有关更多信息，请参阅 注册表事件。

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

Subscribe

AWS IoT 当事物与事物类型关联或与事物thingName类型thingTypeName取消关联时发布到此主题。有关更多信息，请参阅 注册表事件。

$aws/events//thingGroupNamethingthingGroupMembership/thingGroup//thingName已添加

Subscribe

AWS IoT 将事物添加到事物thingName组时发布到此主题thingGroupName。有关更多信息，请参阅 注册表事件。

$aws/events//thingGroupNamethingthingGroupMembership/thingGroup//thingName已移除

Subscribe

AWS IoT 当事物从事物thingName组中移除时发布到此主题thingGroupName。有关更多信息，请参阅 注册表事件。

$aws/events///thingGroupHierarchy/thingGroupch parentThingGroupName ildThingGroup/childThingGroupName/已添加

Subscribe

AWS IoT 将事物组添加到事物组childThingGroupName时发布到此主题parentThingGroupName。有关更多信息，请参阅 注册表事件。

$aws/events///thingGroupHierarchy/thingGroupch parentThingGroupName ildThingGroup/childThingGroupName/已移除

Subscribe

AWS IoT 当事物组从事物组childThingGroupName中移除时发布到此主题parentThingGroupName。有关更多信息，请参阅 注册表事件。

队列预调配主题

注意

此表中注明为 “接收” 的客户端操作表示直接向请求的客户端 AWS IoT 发布的主题，无论客户端是否订阅了该主题。即使客户端尚未订阅这些消息，也会收到这些消息。这些响应消息不会通过消息代理，也无法由其它客户端或规则订阅。

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区，具体取决于payload-format主题。

payload-format 响应格式数据类型
cbor 简洁二进制对象表示法 (CBOR)
json JavaScript 对象表示法 (JSON)

有关更多信息，请参阅 设备预调配 MQTT API。

Topic 允许的客户端操作 说明

$ aws/certificates /创建/ payload-format

发布

发布到此主题以从证书签名请求（CSR）创建证书。

$ aws/certificates /创建//payload-format已接受

订阅，接收

AWS IoT 成功调用 $ aws/certificates /create/ payload-format 后发布到此主题。

$ aws/certificates /创建/ /拒绝 payload-format

订阅，接收

AWS IoT 在调用 $ aws/certificates /create/ payload-format 失败后发布到此主题。

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

发布

发布到此主题以从 CSR 创建证书。

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

订阅，接收

AWS IoT 向该主题发布了对 $ aws/certificates /create-from-csr/ payload-format 的成功调用。

$ aws/certificates /create-from-csr//payload-format已拒绝

 订阅，接收

AWS IoT 向该主题发布了对 $ aws/certificates /create-from-csr/ payload-format 的调用，但未成功。

$ aws/provisioning-模板templateName//provision/ payload-format

发布

发布到此主题以注册事物。

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

 订阅，接收

AWS IoT 成功调用 $ aws/provisioning-templates/ /provision/ templateName 后发布到此主题。payload-format

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

订阅，接收

AWS IoT 在调用 $ aws/provisioning-templates/ /provision/ templateName 失败后发布到此主题。payload-format

任务主题

注意

此表中注明为 “接收” 的客户端操作表示直接向请求的客户端 AWS IoT 发布的主题，无论客户端是否订阅了该主题。即使客户端尚未订阅这些消息，也会收到这些消息。

这些响应消息不会通过消息代理，也无法由其它客户端或规则订阅。要订阅与消息相关的任务活动，请使用 notify 和 notify-next 主题。

当订阅任务和您的实例集监控解决方案的 jobExecution 事件主题时，您必须首先启用任务和任务执行事件接收云端的任何事件。

有关更多信息，请参阅 任务设备 MQTT API 操作。

Topic 允许的客户端操作 说明

$aws/things/thingName/jobs/get

发布

设备向此主题发布一条消息以发出 GetPendingJobExecutions 请求。有关更多信息，请参阅 任务设备 MQTT API 操作。

$aws/things/thingName/jobs/get/已接受

订阅，接收

设备订阅此主题以接收来自 GetPendingJobExecutions 请求的成功响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

$aws/things/thingName/jobs/get/已拒绝

订阅，接收

当 GetPendingJobExecutions 请求被拒绝时，设备会订阅此主题以接收响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

发布

设备向此主题发布一条消息以发出 StartNextPendingJobExecution 请求。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

订阅，接收

设备订阅此主题以接收 StartNextPendingJobExecution 请求的成功响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

订阅，接收

当 StartNextPendingJobExecution 请求被拒绝时，设备会订阅此主题以接收响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

发布

设备向此主题发布一条消息以发出 DescribeJobExecution 请求。有关更多信息，请参阅 任务设备 MQTT API 操作。

$aws/things/thingName/job jobId s//get/accepted

订阅，接收

设备订阅此主题以接收 DescribeJobExecution 请求的成功响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

$aws/things/thingName/job jobId s//get/rejected

订阅，接收

当 DescribeJobExecution 请求被拒绝时，设备会订阅此主题以接收响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

发布

设备向此主题发布一条消息以发出 UpdateJobExecution 请求。有关更多信息，请参阅 任务设备 MQTT API 操作。

$aws/things/thingName/job jobId s//update/accepted

订阅，接收

设备订阅此主题以接收 UpdateJobExecution 请求的成功响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

备注

只有发布到 $aws/things/thingName/jobs/ jobId /update 的设备才能收到有关此主题的消息。

$aws/things/thingName/job jobId s//update/rejected

订阅，接收

当 UpdateJobExecution 请求被拒绝时，设备会订阅此主题以接收响应。有关更多信息，请参阅 任务设备 MQTT API 操作。

备注

只有发布到 $aws/things/thingName/jobs/ jobId /update 的设备才能收到有关此主题的消息。

$aws/things/thingName/jobs/notify

订阅，接收

设备订阅此主题，以在某个事物的待处理执行列表中添加或删除了任务执行时接收通知。有关更多信息，请参阅 任务设备 MQTT API 操作。

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

订阅，接收

设备订阅此主题，以在事物的下一个待处理任务执行发生更改时接收通知。有关更多信息，请参阅 任务设备 MQTT API 操作。

$ aws/events /job//jobId已完成

Subscribe

当某个任务完成时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /job//jobId已取消

Subscribe

当取消某个任务时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /job//jobId已删除

Subscribe

当删除某个任务时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /job/ /cancellation_in_progress jobId

Subscribe

当开始取消某个任务时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /job/ /deletion_in_progress jobId

Subscribe

当开始删除某个任务时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution/ /成功 jobId

Subscribe

当任务执行成功时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution/ /失败 jobId

Subscribe

当任务执行失败时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution//jobId已拒绝

Subscribe

当任务执行被拒绝时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution//jobId已取消

Subscribe

当任务执行取消时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution//jobIdtimed_out

Subscribe

当任务执行超时时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution//jobId已移除

Subscribe

当任务执行被移除时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

$ aws/events /jobExecution//jobId已删除

Subscribe

当任务执行被删除时，任务服务在此主题上发布事件。有关更多信息，请参阅 任务事件。

命令主题

注意

此表中注明为 “接收” 的客户端操作表示直接向请求的客户端 AWS IoT 发布的主题，无论客户端是否订阅了该主题。即使客户端尚未订阅这些消息，也会收到这些消息。

这些响应消息不会通过消息代理，也无法由其它客户端或规则订阅。

Topic 允许的客户端操作 说明

$aws/commands///<DeviceID>execution <devices> s/ /requ <ExecutionId> est/ <PayloadFormat>

$aws/commands///<DeviceID>execut <devices> ions/ /reques <ExecutionId> t

订阅，接收

当从控制台或使用 StartCommandExecution API 请求启动命令执行时，设备会在此主题上收到一条消息。在这种情况下，<devices>可以是物联网事物或 MQTT 客户端，<DeviceID>可以是物联网事物名称或 MQTT 客户端 ID。

$aws/commands///<DeviceID>execution <devices> s/ /respon <ExecutionId> se/ <PayloadFormat>

发布

设备使用 UpdateCommandExecution MQTT API 将有关命令执行的消息发布到此主题。该消息是作为对从控制台或使用 StartCommandExecution API 启动命令执行请求的响应而发布的。发布的消息将使用 JSON 或 CBOR 作为。<PayloadFormat>

$ aws/commands<devices>//<DeviceID>/executions<ExecutionId>///response/accepted<PayloadFormat>

$aws/commands///<DeviceID>execution <devices> <ExecutionId> s//response/accepted

订阅，接收

如果云服务成功处理了命令执行结果， AWS IoT Device Management 会向 /accepted 主题发布响应。

$ aws/commands<devices>//<DeviceID>/executions<ExecutionId>///response/rejected<PayloadFormat>

$aws/commands///<DeviceID>execution <devices> <ExecutionId> s//response/rejected

发布

如果云服务未能处理命令执行结果， AWS IoT Device Management 会向 /rejected 主题发布响应。

规则主题

Topic 允许的客户端操作 说明

$aws/rules/ruleName

发布

设备或应用程序向此主题发布消息以直接触发规则。有关更多信息，请参阅 借助基本摄取功能，降低消息收发成本。

安全隧道主题

Topic 允许的客户端操作 说明

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

Subscribe

AWS IoT 发布此消息，让 IoT 代理在远程设备上启动本地代理。有关更多信息，请参阅 IoT 代理代码段。

影子主题

本节中的主题由命名和未命名的影子使用。每个影子使用的主题仅在主题前缀上有所不同。下表显示每种影子类型使用的主题前缀。

ShadowTopicPrefix 值 影子类型
$aws/things/thingName/shadow 未命名的（经典）影子
$aws/things/thingName/shadow/name/shadowName 命名的影子

要创建完整的主题，请ShadowTopicPrefix为要引用的影子类型选择，将thingName和（如果适用）替换为相应的值，然后将其附加到主题存根，如下表所示。shadowName请记住，主题区分大小写。

Topic 允许的客户端操作 说明

ShadowTopicPrefix/删除

Publish/Subscribe

设备或应用程序向此主题发布消息以删除影子。有关更多信息，请参阅 /delete。

ShadowTopicPrefix/delete/accepted

Subscribe

当一个影子被删除时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/delete/accepted。

ShadowTopicPrefix/delete/rejected

Subscribe

当删除影子的请求遭拒时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/delete/rejected。

ShadowTopicPrefix/获取

Publish/Subscribe

应用程序或事物向此主题发布空消息来获取影子。有关更多信息，请参阅 Device Shadow MQTT 主题。

ShadowTopicPrefix/get/accepted

Subscribe

当获取影子的请求获批时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/get/accepted。

ShadowTopicPrefix/get/rejected

Subscribe

当获取影子的请求遭拒时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/get/rejected。

ShadowTopicPrefix/更新

Publish/Subscribe

事物或应用程序向此主题发布消息以更新影子。有关更多信息，请参阅 /update。

ShadowTopicPrefix/update/accepted

Subscribe

当影子更新成功时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/update/accepted。

ShadowTopicPrefix/update/rejected

Subscribe

当影子更新遭拒时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/update/rejected。

ShadowTopicPrefix/update/delta

Subscribe

当检测到影子的“reported”部分与“desired”部分之间存在差异时，Device Shadow 服务将向此主题发送消息。有关更多信息，请参见/update/delta。

ShadowTopicPrefix/update/documents

Subscribe

AWS IoT 每当成功执行影子更新时，都会向该主题发布状态文档。有关更多信息，请参见/update/documents。

MQTT-based 文件交付主题

注意

此表中注明为 “接收” 的客户端操作表示直接向请求的客户端 AWS IoT 发布的主题，无论客户端是否订阅了该主题。即使客户端尚未订阅这些消息，也会收到这些消息。这些响应消息不会通过消息代理，也无法由其它客户端或规则订阅。

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区，具体取决于payload-format主题。

payload-format 响应格式数据类型
cbor 简洁二进制对象表示法 (CBOR)
json JavaScript 对象表示法 (JSON)
Topic 允许的客户端操作 说明

$aws/things/ThingName/streams/ /dataStreamId/payload-format

订阅，接收

AWS MQTT-based 如果接受来自设备的 “GetStream” 请求，则文件传输将发布到此主题。有效载荷包含流数据。有关更多信息，请参阅 使用 AWS IoT MQTT-based 设备中的文件传输。

$aws/things/ThingName/streams/ /getStreamId/payload-format

发布

设备向该主题发布内容以执行 “GetStream” 请求。有关更多信息，请参阅 使用 AWS IoT MQTT-based 设备中的文件传输。

$aws/things/ThingName/streams/ /descri StreamId ption/ payload-format

订阅，接收

AWS MQTT-based 如果接受来自设备的 “DescribeStream” 请求，则文件传输将发布到此主题。有效载荷包含流描述。有关更多信息，请参阅 使用 AWS IoT MQTT-based 设备中的文件传输。

$aws/things/ThingName/streams/ /describ StreamId e/ payload-format

发布

设备向该主题发布内容以执行 “DescribeStream” 请求。有关更多信息，请参阅 使用 AWS IoT MQTT-based 设备中的文件传输。

$aws/things/ThingName/streams/ /拒绝StreamId/payload-format

订阅，接收

AWS MQTT-based 如果来自设备的 “” 或 “DescribeStreamGetStream” 请求被拒绝，文件传输将发布到此主题。有关更多信息，请参阅 使用 AWS IoT MQTT-based 设备中的文件传输。

保留的主题 ARN

所有保留的主题 ARN (Amazon Resource Name) 均采用以下形式：

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。