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

保留的主题

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

资产模型主题

主题 允许的客户端操作 描述

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

Subscribe

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

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 之后,AWS IoT 发布到此主题。有关更多信息,请参阅从设备发送指标

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

Subscribe

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

事件主题

主题 允许的客户端操作 描述

$aws/events/certificates/registered/caCertificateId

Subscribe

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

$aws/events/presence/connected/clientId

订阅

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

$aws/events/presence/disconnected/clientId

订阅

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

$aws/events/subscriptions/subscribed/clientId

订阅

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

$aws/events/subscriptions/unsubscribed/clientId

订阅

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

$aws/events/thing/thingName/created

Subscribe

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

$aws/events/thing/thingName/updated

Subscribe

在更新了 ThingName 事物时,AWS IoT 发布到此主题。有关更多信息,请参阅注册表事件

$aws/events/thing/thingName/deleted

Subscribe

在删除了 ThingName 事物时,AWS IoT 发布到此主题。有关更多信息,请参阅注册表事件

$aws/events/thingGroup/thingGroupName/created

Subscribe

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

$aws/events/thingGroup/thingGroupName/updated

Subscribe

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

$aws/events/thingGroup/thingGroupName/deleted

Subscribe

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

$aws/events/thingType/thingTypeName/created

Subscribe

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

$aws/events/thingType/thingTypeName/updated

Subscribe

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

$aws/events/thingType/thingTypeName/deleted

Subscribe

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

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

Subscribe

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

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

Subscribe

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

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

Subscribe

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

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

Subscribe

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

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

Subscribe

在将事物组 childThingGroupName 从事物组 parentThingGroupName 中删除时,AWS 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 后,AWS IoT 发布到此主题。

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

Subscribe

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

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

发布

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

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

Subscribe

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

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

Subscribe

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

$aws/events/presence/connected/clientId

订阅

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

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

发布

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

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

Subscribe

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

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

Subscribe

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

作业主题

主题 允许的客户端操作 描述

$aws/things/thingName/jobs/get

发布

设备向此主题发布一条消息以发出 GetPendingJobExecutions 请求。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

设备订阅此主题以接收来自 GetPendingJobExecutions 请求的成功响应。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

GetPendingJobExecutions 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅使用 AWS IoT 作业 API

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

发布

设备向此主题发布一条消息以发出 StartNextPendingJobExecution 请求。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

设备订阅此主题以接收 StartNextPendingJobExecution 请求的成功响应。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

StartNextPendingJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅使用 AWS IoT 作业 API

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

发布

设备向此主题发布一条消息以发出 DescribeJobExecution 请求。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

设备订阅此主题以接收 DescribeJobExecution 请求的成功响应。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

DescribeJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅使用 AWS IoT 作业 API

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

发布

设备向此主题发布一条消息以发出 UpdateJobExecution 请求。有关更多信息,请参阅使用 AWS IoT 作业 API

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

订阅

设备订阅此主题以接收 UpdateJobExecution 请求的成功响应。有关更多信息,请参阅使用 AWS IoT 作业 API

注意

仅向 $aws/things/thingName/jobs/jobId/update 发布消息的设备将收到有关此主题的消息。

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

订阅

UpdateJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅使用 AWS IoT 作业 API

注意

仅向 $aws/things/thingName/jobs/jobId/update 发布消息的设备将收到有关此主题的消息。

$aws/things/thingName/jobs/notify

订阅

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

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

订阅

设备订阅此主题,以在事物的下一个待处理作业执行发生更改时接收通知。有关更多信息,请参阅使用 AWS IoT 作业 API

$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

Subscribe

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

影子主题

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

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

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

主题 允许的客户端操作 描述

ShadowTopicPrefix/delete

发布/订阅

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

ShadowTopicPrefix/delete/accepted

订阅

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

ShadowTopicPrefix/delete/rejected

订阅

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

ShadowTopicPrefix/get

发布/订阅

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

ShadowTopicPrefix/get/accepted

订阅

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

ShadowTopicPrefix/get/rejected

订阅

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

ShadowTopicPrefix/update

发布/订阅

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

ShadowTopicPrefix/update/accepted

订阅

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

ShadowTopicPrefix/update/rejected

订阅

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

ShadowTopicPrefix/update/delta

订阅

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

ShadowTopicPrefix/update/documents

订阅

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