保留的主题 - AWS IoT Core

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

保留的主题

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

资产模型主题

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

$aws/sitewise/asset-models/assetModelId/资产/assetId/属性/propertyId

订阅

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

Device Defender 主题

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

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

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

主题 允许的操作 描述

$aws/事物/thingName/defender/metrics/payload-format

发布

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

$aws/事物/thingName/defender/metrics/payload-format/已接受

订阅

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

$aws/事物/thingName/defender/metrics/payload-format/已拒绝

订阅

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

事件主题

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

$aws/events/证书/已注册/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/unsubscribeed/clientId

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

$aws/events/thingGroupMembership/thingGroup/thingGroupName/事物/thingName/已添加

订阅

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

$aws/events/thingGroupMembership/thingGroup/thingGroupName/事物/thingName/已删除

订阅

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

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/已添加

订阅

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

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/已删除

订阅

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

队列预置主题

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

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

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

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

$aws/证书/create/payload-format

发布

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

$aws/证书/create/payload-format/已接受

订阅

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

$aws/证书/create/payload-format/已拒绝

订阅

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

$aws/证书/create-from-csr/payload-format

发布

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

$aws/证书/create-from-csr/payload-format/已接受

订阅

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

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

订阅

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

$aws/events/presence/connected/clientId

订阅

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

$aws/provisioning-templates/templateName/预配置/payload-format

发布

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

$aws/provisioning-templates/templateName/预配置/payload-format/已接受

订阅

AWS IoT 在成功调用 $aws/provisioning-templates/ 后发布到此主题templateName/预配置/payload-format.

$aws/provisioning-templates/templateName/预配置/payload-format/已拒绝

订阅

AWS IoT 在不成功调用 $aws/provisioning-templates/ 后发布到此主题templateName/预配置/payload-format.

作业主题

注意

此表中名为 Receive (接收) 的客户端操作指示 AWS IoT 直接向请求它的客户端发布的主题,无论客户端是否已订阅该主题。即使客户端尚未订阅这些响应消息,客户端也应该会收到这些响应消息。

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

有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

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

$aws/事物/thingName/任务/get

发布

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

$aws/事物/thingName/jobs/get/accepted

订阅,接收

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

$aws/事物/thingName/jobs/get/rejected

订阅,接收

GetPendingJobExecutions 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

$aws/事物/thingName/jobs/start-next

发布

设备向此主题发布一条消息以发出 StartNextPendingJobExecution 请求。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

$aws/事物/thingName/jobs/start-next/accepted

订阅,接收

设备订阅此主题以接收 StartNextPendingJobExecution 请求的成功响应。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

$aws/事物/thingName/jobs/start-next/rejected

订阅,接收

StartNextPendingJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

$aws/事物/thingName/作业/jobId/get

发布

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

$aws/事物/thingName/作业/jobId/get/accepted

订阅,接收

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

$aws/事物/thingName/作业/jobId/get/rejected

订阅,接收

DescribeJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

$aws/事物/thingName/作业/jobId/update

发布

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

$aws/事物/thingName/作业/jobId/update/accepted

订阅,接收

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

Note

仅发布到 $aws/things/ 的设备thingName/作业/jobId/update 收到关于此主题的消息。

$aws/事物/thingName/作业/jobId/update/rejected

订阅,接收

UpdateJobExecution 请求被拒绝时,设备会订阅此主题。有关更多信息,请参阅 作业设备 MQTT 和 HTTPS API.

Note

仅发布到 $aws/things/ 的设备thingName/作业/jobId/update 收到关于此主题的消息。

$aws/事物/thingName/作业/通知

订阅

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

$aws/事物/thingName/jobs/notify-next

订阅

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

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

订阅

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

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

订阅

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

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

订阅

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

$aws/events/job/jobId/cancellation_in_progress

订阅

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

$aws/events/job/jobId/deletion_in_progress

订阅

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

$aws/events/jobExecution/jobId/成功

订阅

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

$aws/events/jobExecution/jobId/失败

订阅

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

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

订阅

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

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

订阅

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

$aws/events/jobExecution/jobId/timed_out

订阅

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

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

订阅

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

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

订阅

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

规则主题

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

$aws/rules/ruleName

发布

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

安全隧道主题

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

$aws/事物/thing-name/tunnels/notify

订阅

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

影子主题

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

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

要创建完整主题,请选择 ShadowTopicPrefix 对于要引用的影子的类型,请替换 thingName 并且,如果适用,shadowName,使用其对应的值,然后将该值与主题存根一起附加,如下表所示。请记住,主题区分大小写。

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

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.

流式处理服务主题

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

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

$aws/事物/ThingName/流/StreamId/数据/payload-format

订阅

如果接受来自设备的“AWSGetStreamGetStream 流式处理服务将发布到此主题。负载包含流数据。有关更多信息,请参阅 在设备中使用流AWS IoT式处理服务.

$aws/事物/ThingName/流/StreamId/get/payload-format

发布

设备发布到此主题以执行“GetStream”请求。有关更多信息,请参阅 在设备中使用流AWS IoT式处理服务.

$aws/事物/ThingName/流/StreamId/描述/payload-format

订阅

如果接受来自设备的“AWSDescribeStreamDescribeStream 流式处理服务将发布到此主题。负载包含流描述。有关更多信息,请参阅 在设备中使用流AWS IoT式处理服务.

$aws/事物/ThingName/流/StreamId/描述/payload-format

发布

设备发布到此主题以执行“DescribeStream”请求。有关更多信息,请参阅 在设备中使用流AWS IoT式处理服务.

$aws/事物/ThingName/流/StreamId/已拒绝/payload-format

订阅

如果来自设备的“AWSDescribeStreamDescribeStreamGetStreamGetStream 流式处理服务将发布到此主题。有关更多信息,请参阅 在设备中使用流AWS IoT式处理服务.

保留的主题 ARN

所有预留主题 ARNs (Amazon 资源名称) 具有以下形式:

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。