保留的主题 - Amazon IoT Core
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

保留的主题

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

资产模型主题

主题 允许的客户端操作 说明

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

Subscribe

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

Device Defender 主题

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

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

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

主题 允许的操作 说明

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

发布

Device Defender 代理将指标发布到该主题。有关更多信息,请参阅 从设备发送指标

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

Subscribe

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

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

Subscribe

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

事件主题

主题 允许的客户端操作 说明

$aws/events/certificates/registered/caCertificateId

Subscribe

在 Amazon IoT 自动注册证书以及客户端呈现具有 Amazon IoT 状态的证书时,PENDING_ACTIVATION 发布此消息。有关更多信息,请参阅 配置客户端的首次连接以进行自动注册

$aws/events/job/jobID/canceled

Subscribe

当取消某个任务时,Amazon IoT 会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/cancellation_in_progress

Subscribe

当某个任务正在被取消时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件

$aws/events/job/jobID/completed

Subscribe

当完成某个任务时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/deleted

Subscribe

当某个任务被删除时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/deletion_in_progress

Subscribe

当某个任务正在被删除时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/canceled

Subscribe

当取消某个任务执行时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/deleted

Subscribe

当删除某个任务执行时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/failed

Subscribe

当某个任务执行失败时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/rejected

Subscribe

当某个任务执行被拒绝时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/removed

Subscribe

当某个任务执行被删除时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/succeeded

Subscribe

当任务执行成功时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/timed_out

Subscribe

当某个任务执行超时,Amazon IoT 将发布此消息。有关更多信息,请参阅 任务事件

$aws/events/presence/connected/clientId

Subscribe

Amazon IoT当使用特定客户端 ID 的 MQTT 客户端连接至 时, 将向此主题发布。Amazon IoT有关更多信息,请参阅 连接/断开连接事件

$aws/events/presence/disconnected/clientId

Subscribe

Amazon IoT当使用特定客户端 ID 的 MQTT 客户端断开连接至 时, 将向此主题发布。Amazon IoT有关更多信息,请参阅 连接/断开连接事件

$aws/events/subscriptions/subscribed/clientId

Subscribe

Amazon IoT当使用特定客户端 ID 的 MQTT 客户端订阅 MQTT 主题时, 将向此主题发布。有关更多信息,请参阅 订阅/取消订阅事件

$aws/events/subscriptions/unsubscribed/clientId

Subscribe

Amazon IoT当使用特定客户端 ID 的 MQTT 客户端取消订阅 MQTT 主题时, 将向此主题发布。有关更多信息,请参阅 订阅/取消订阅事件

$aws/events/thing/thingName/created

Subscribe

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

$aws/events/thing/thingName/updated

Subscribe

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

$aws/events/thing/thingName/deleted

Subscribe

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

$aws/events/thingGroup/thingGroupName/created

Subscribe

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

$aws/events/thingGroup/thingGroupName/updated

Subscribe

当更新了事物组 thingGroupName 时,Amazon IoT 将发布到此主题。有关更多信息,请参阅 注册表事件

$aws/events/thingGroup/thingGroupName/deleted

Subscribe

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

$aws/events/thingType/thingTypeName/created

Subscribe

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

$aws/events/thingType/thingTypeName/updated

Subscribe

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

$aws/events/thingType/thingTypeName/deleted

Subscribe

当删除了 thingTypeName 事物类型时,Amazon IoT 将发布到此主题。有关更多信息,请参阅 注册表事件

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

Subscribe

当事物 thingName 与事物类型 thingTypeName 相关联或与断开关联,时,Amazon IoT 将发布到此主题。有关更多信息,请参阅 注册表事件

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

Subscribe

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

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

Subscribe

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

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

Subscribe

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

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

Subscribe

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

队列预置主题

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

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

有关更多信息,请参阅 设备预置 MQTT API

主题 允许的客户端操作 说明

$aws/certificates/create/payload-format

发布

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

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

Subscribe

当成功调用 $aws/certificates/create/payload-format 时,Amazon IoT 将发布到此主题。

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

Subscribe

当未成功调用 $aws/certificates/create/payload-format 时,Amazon IoT 将发布此主题。

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

发布

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

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

Subscribe

Amazon IoT 将对 $aws/certificates/create-from-csr/payload-format 的成功调用发布到此主题。

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

Subscribe

Amazon IoT 将对 $aws/certificates/create-from-csr/payload-format 的不成功调用发布到此主题。

$aws/events/presence/connected/clientId

Subscribe

Amazon IoT当使用特定客户端 ID 的 MQTT 客户端连接至 时, 将向此主题发布。Amazon IoT有关更多信息,请参阅 连接/断开连接事件

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

发布

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

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

Subscribe

当成功调用 $aws/provisioning-templates/templateName/provision/payload-format 时,Amazon IoT 将发布到此主题。

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

Subscribe

当未成功调用 $aws/provisioning-templates/templateName/provision/payload-format 时,Amazon IoT 将发布到此主题。

任务主题

注意

此表中标记为 Receive(接收)的客户端操作表示无论客户端是否订阅了主题,Amazon IoT 都会直接向发出请求的客户端发布的主题。即使客户端尚未订阅这些消息,其也应收到这些响应消息。

这些响应消息不会通过消息代理,也无法由其他客户端或规则订阅。要订阅与工作活动消息相关的任务活动,请使用 notifynotify-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

Subscribe

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

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

Subscribe

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

$aws/events/job/jobId/completed

Subscribe

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

$aws/events/job/jobId/canceled

Subscribe

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

$aws/events/job/jobId/deleted

Subscribe

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

$aws/events/job/jobId/cancellation_in_progress

Subscribe

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

$aws/events/job/jobId/deletion_in_progress

Subscribe

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

$aws/events/jobExecution/jobId/succeeded

Subscribe

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

$aws/events/jobExecution/jobId/failed

Subscribe

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

$aws/events/jobExecution/jobId/rejected

Subscribe

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

$aws/events/jobExecution/jobId/canceled

Subscribe

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

$aws/events/jobExecution/jobId/timed_out

Subscribe

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

$aws/events/jobExecution/jobId/removed

Subscribe

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

$aws/events/jobExecution/jobId/deleted

Subscribe

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

规则主题

主题 允许的客户端操作 说明

$aws/rules/ruleName

发布

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

安全隧道主题

主题 允许的客户端操作 说明

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

Subscribe

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

影子主题

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

ShadowTopicPrefix 影子类型
$aws/things/thingName/shadow 未命名的(经典)影子
$aws/things/thingName/shadow/name/shadowName 命名的影子

要创建完整的主题,请为要表示的影子类型选择 ShadowTopicPrefix,将 thingNameshadowName(如果适用)替换为相应的值,然后在其后面附加主题存根,如下表中所示。请记住,主题区分大小写。

主题 允许的客户端操作 说明

ShadowTopicPrefix/delete

发布/订阅

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

ShadowTopicPrefix/delete/accepted

Subscribe

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

ShadowTopicPrefix/delete/rejected

Subscribe

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

ShadowTopicPrefix/get

发布/订阅

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

ShadowTopicPrefix/get/accepted

Subscribe

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

ShadowTopicPrefix/get/rejected

Subscribe

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

ShadowTopicPrefix/update

发布/订阅

事物或应用程序向此主题发布消息以更新影子。有关更多信息,请参阅 /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

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

基于 MQTT 的文件传输主题

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

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

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

Subscribe

如果接受来自设备的“GetStream”请求,则Amazon基于 MQTT 的文件传输将发布到此主题。负载包含流数据。有关更多信息,请参阅 在设备中使用 Amazon IoT 基于 MQTT 的文件传输

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

发布

设备向此主题发布消息以执行“GetStream”请求。有关更多信息,请参阅 在设备中使用 Amazon IoT 基于 MQTT 的文件传输

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

Subscribe

如果接受来自设备的“DescribeStream”请求,则Amazon基于 MQTT 的文件传输将发布到此主题。负载包含流描述。有关更多信息,请参阅 在设备中使用 Amazon IoT 基于 MQTT 的文件传输

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

发布

设备向此主题发布消息以执行“DescribeStream”请求。有关更多信息,请参阅 在设备中使用 Amazon IoT 基于 MQTT 的文件传输

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

Subscribe

如果来自设备的“DescribeStream”或“GetStream”请求被拒绝,则Amazon基于 MQTT 的文件传输将发布到此主题。有关更多信息,请参阅 在设备中使用 Amazon IoT 基于 MQTT 的文件传输

保留的主题 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。