保留的主题 - AWS IoT Core

保留的主题

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

资产模型主题

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

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

订阅

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)

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

主题 允许的操作 描述

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

Publish

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

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

订阅

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

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

订阅

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

AWS IoT Core 设备位置主题

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

主题 允许的操作 描述

$aws/device_location/customer_device_id/get_position_estimate

Publish

设备向本主题发布信息以获取扫描的原始测量数据,以便通过 AWS IoT Core 设备位置功能进行解析。

$aws/device_location/customer_device_id/get_position_estimate/accepted

订阅

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

$aws/device_location/customer_device_id/get_position_estimate/rejected

订阅

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

事件主题

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

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

$aws/events/certificates/registered/caCertificateId

订阅

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

$aws/events/job/jobID/canceled

订阅

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

订阅

当正在执行任务取消时,AWS IoT 发布此消息。有关更多信息,请参阅 任务事件

$aws/events/job/jobID/completed

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

当某个任务执行超时,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

订阅

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

$aws/events/thing/thingName/updated

订阅

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

$aws/events/thing/thingName/deleted

订阅

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

$aws/events/thingGroup/thingGroupName/created

订阅

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

$aws/events/thingGroup/thingGroupName/updated

订阅

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

$aws/events/thingGroup/thingGroupName/deleted

订阅

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

$aws/events/thingType/thingTypeName/created

订阅

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

$aws/events/thingType/thingTypeName/updated

订阅

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

$aws/events/thingType/thingTypeName/deleted

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

队列预置主题

注意

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

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

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

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

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

$aws/certificates/create/payload-format

Publish

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

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

订阅,接收

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

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

订阅,接收

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

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

Publish

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

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

订阅,接收

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

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

订阅,接收

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

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

Publish

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

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

订阅,接收

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

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

订阅,接收

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

任务主题

注意

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

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

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

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

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

$aws/things/thingName/jobs/get

Publish

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

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

订阅,接收

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

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

订阅,接收

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

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

Publish

设备向此主题发布一条消息以发出 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/jobId/get

Publish

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

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

订阅,接收

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

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

订阅,接收

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

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

Publish

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

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

订阅,接收

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

备注

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

$aws/things/thingName/jobs/jobId/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/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

Publish

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

安全隧道主题

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

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

订阅

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

基于 MQTT 的文件传输主题

注意

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

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

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

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

订阅,接收

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

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

Publish

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

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

订阅,接收

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

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

Publish

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

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

订阅,接收

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