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

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

保留的主题

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

资产模型主题

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

$aws/sitewise/asset-models/ /assets/ assetiD /properties/ properties/ properties/ pro assetModelId

订阅

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

Amazon IoT Device Defender 话题

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

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

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

主题 允许的操作 描述

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

Publish

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

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

订阅

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

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

订阅

Amazon IoT 在 Amazon IoT Device Defender 代理以 $aws/things/ thingName /defender/metrics/ payload-formation 发布一条失败的消息后,向该主题发布消息。有关更多信息,请参阅从设备发送指标

Amazon IoT Core 设备位置主题

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

主题 允许的操作 描述

$aws/device_location/customer_device_id/get_position_estimate

Publish

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

$aws/device_location/customer_device_id/get_position_estimate/accepted

订阅

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

$aws/device_location/customer_device_id/get_position_estimate/rejected

订阅

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

事件主题

注意

有关为 LoRa WAN 事件保留的 MQTT 主题的更多信息,请参阅连接状态事件

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

$aws/活动/证书/已注册/ caCertificateId

订阅

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

$aws/events/job/jobID/canceled

订阅

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

订阅

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

$aws/events/job/jobID/completed

订阅

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

订阅

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

订阅

Amazon IoT 删除任务时会发布此消息。有关更多信息,请参阅任务事件
$aws/events/jobExecution/jobID/canceled

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

订阅

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

$aws/events/presence/connected/clientId

订阅

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

$aws/events/presence/disconnected/clientId

订阅

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

$aws/events/subscriptions/subscribed/clientId

订阅

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

$aws/events/subscriptions/unsubscribed/clientId

订阅

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

$aws/events/thing/thingName/created

订阅

Amazon IoT 在创建 Thing Name 事物时向该主题发布。有关更多信息,请参阅注册表事件

$aws/events/thing/thingName/updated

订阅

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

$aws/events/thing/thingName/deleted

订阅

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

$aw thingGroupNames/events/ThingGroup//

订阅

Amazon IoT 在创建事物组thingGroupName时向该主题发布内容。有关更多信息,请参阅注册表事件

$aw thingGroupNames/events/ThingGroup//

订阅

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

$aw thingGroupNames/events/ThingGroup//

订阅

Amazon IoT 删除事物组thingGroupName后,向该主题发布内容。有关更多信息,请参阅注册表事件

$aw thingTypeNames/events/ThingType//

订阅

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

$aw thingTypeNames/events/ThingType//

订阅

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

$aw thingTypeNames/events/ThingType//

订阅

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

$aws/events/ /thing/ thingName/thingTypeAssociationthingTypeName

订阅

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

$aws/events/ /ThingGroup/ /thing/ thingName /ad thingGroupMembership ded thingGroupName

订阅

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

$aws/events/ /ThingGroup/ /thing/ thingName /已移thingGroupMembership除 thingGroupName

订阅

Amazon IoT 将事物 Thing Name 从事物组中移除后,将发布到该主题。thingGroupName有关更多信息,请参阅注册表事件

thingGroupHierarchy$aws/events/ /ThingGroup/ 姓名//姓名 /add parentThingGroup ed childThingGroup childThingGroup

订阅

Amazon IoT 将事物组名称添加到事物组childThingGroup名称时发布到该主题。parentThingGroup有关更多信息,请参阅注册表事件

thingGroupHierarchy$aws/events/ /ThingGroup/ 姓名//姓名 parentThingGroup /已删除 childThingGroup childThingGroup

订阅

Amazon IoT 从事物组名称中移除事物组childThingGroup名称后,将发布到该主题。parentThingGroup有关更多信息,请参阅注册表事件

队列预置主题

注意

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

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

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

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

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

$aws/certificates/create/payload-format

Publish

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

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

订阅,接收

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

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

订阅,接收

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

$aws/证书//有效载荷格式 create-from-csr

Publish

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

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

订阅,接收

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

$aws/证书//有效载荷格式/create-from-csr已拒绝

订阅,接收

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

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

Publish

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

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

订阅,接收

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

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

订阅,接收

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

任务主题

注意

此表中标为 “接收” 的客户端操作表示直接向请求它的客户端 Amazon 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

订阅

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

影子主题

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

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

要创建完整的主题,请选择要引ShadowTopicPrefix用的阴影类型,将 thing Name 和 sh adowName(如果适用)替换为相应的值,然后将其与主题存根一起追加,如下表所示。请记住,主题区分大小写。

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

ShadowTopicPrefix/删除

发布/订阅

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

ShadowTopicPrefix/删除/接受

订阅

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

ShadowTopicPrefix/删除/已拒绝

订阅

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

ShadowTopicPrefix/get

发布/订阅

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

ShadowTopicPrefix/获取/接受

订阅

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

ShadowTopicPrefix/get/被拒绝

订阅

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

ShadowTopicPrefix/更新

发布/订阅

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

ShadowTopicPrefix/更新/已接受

订阅

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

ShadowTopicPrefix/更新/已拒绝

订阅

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

ShadowTopicPrefix/update/delta

订阅

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

ShadowTopicPrefix/更新/文档

订阅

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

基于 MQTT 的文件传输主题

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

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

$aws/things/ /streams/ /data/ 有效载荷格式 ThingNameStreamId

订阅

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

$aws/things/ /streams/ /get/ payl ThingNameoad-format StreamId

Publish

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

$aws/things/ /streams/ /descrip ThingNametion/ 有效载荷格式 StreamId

订阅

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

$aws/things/ /streams/ /describ ThingNamee/ 有效载荷格式 StreamId

Publish

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

$aws/things/ /streams/ /rejec ThingNameted/ payload-format StreamId

订阅

Amazon 如果来自设备的 “” 或 “DescribeStreamGetStream” 请求被拒绝,则基于 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。