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

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

管理事物索引

AWS_Things 是为您的所有事物创建的索引。您可以从以下数据源控制要索引的内容：Amazon IoT 注册表数据，Amazon IoT 设备影子数据，Amazon IoT 连接数据以及 Amazon IoT Device Defender 违规数据。

启用事物索引

您可以使用 update-indexing-configuration CLI 命令或 UpdateIndexingConfigurationAPI 操作来创建索引并控制AWS_Things其配置。--thing-indexing-configuration (thingIndexingConfiguration) 参数允许您控制建立索引的数据类型（例如，注册表、影子和设备连接数据和Device Defender 违规数据）。

--thing-indexing-configuration 参数采用具有以下结构的字符串：

{
  "thingIndexingMode": "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW",
  "thingConnectivityIndexingMode": "OFF"|"STATUS",
  "deviceDefenderIndexingMode": "OFF"|"VIOLATIONS",
  "namedShadowIndexingMode": "OFF"|"ON",
  "managedFields": [
    {
      "name": "string",
      "type": "Number"|"String"|"Boolean"
    }, 
    ...
  ], 
  "customFields": [
    { 
      "name": "string",
      "type": "Number"|"String"|"Boolean" 
    },
    ...
  ],
  "filter": {
     "namedShadowNames": [ "string" ],
     "geoLocations": [
        {
            "name": "String",
            "order": "LonLat|LatLon"
        }
    ],
     "connectivity": {
        "includeSocketInformation": [
           "GET_THING_CONNECTIVITY_DATA"
        ]
     }
  }
}

事物索引模式

您可以在索引配置中指定不同的事物索引模式，具体取决于要从哪些数据来源编制索引和搜索设备：

下表显示了每种索引模式的有效值以及为每个值编入索引的数据来源。

托管字段和自定义字段

托管字段

托管字段包含与事物、事物组、设备影子、设备连接和 Device Defender 违规相关的数据。 Amazon IoT 定义托管字段中的数据类型。您可以在创建 Amazon IoT 事物时指定每个托管式字段的值。例如，事物名称、事物组和事物描述都是托管字段。实例集索引根据您指定的索引模式为托管式字段编制索引。托管字段无法更改或显示在 customFields 中。

自定义字段

您可以通过创建自定义字段来对属性、Device Shadow 数据和 Device Defender 违规数据进行汇总来进行索引。customFields 属性是字段名称和数据类型对的列表。您可以根据数据类型执行聚合查询。您选择的索引模式会影响可以在 customFields 中指定的字段。例如，如果您指定 REGISTRY 索引模式，则无法从事物影子中指定字段。您可以使用更新索引配置 CLI 命令创建或更新自定义字段的（请参阅更新索引配置示例中的示例命令)。有关更多信息，请参阅自定义字段。

索引筛选器

索引过滤器为命名阴影、地理位置和连接数据提供了其他选择。

namedShadowNames

要将命名影子添加到实例集索引配置，请将 namedShadowIndexingMode 设置为 ON，并在 namedShadowNames 中指定命名影子名称。

示例

"filter": {
     "namedShadowNames": [ "namedShadow1", "namedShadow2" ]
}

geoLocations

要将地理位置数据添加到实例集索引配置，请执行以下操作：

connectivity

有关更多信息，请参阅《Amazon IoTAPI IndexingFilter参考》。

更新索引配置示例

要更新您的索引配置，请使用 Amazon IoT update-indexing-configuration CLI 命令。以下示例显示了如何使用 update-indexing-configuration 标签。

简短语法：

aws iot update-indexing-configuration --thing-indexing-configuration \
'thingIndexingMode=REGISTRY_AND_SHADOW, deviceDefenderIndexingMode=VIOLATIONS, 
namedShadowIndexingMode=ON,thingConnectivityIndexingMode=STATUS,
filter={namedShadowNames=[namedShadow1],geoLocations=[{name=shadow.name.namedShadow1.reported.location,order=LonLat}],connectivity={includeSocketInformation=[GET_THING_CONNECTIVITY_DATA]}},
customFields=[{name=attributes.version,type=Number},
{name=shadow.name.namedShadow1.desired.DefaultDesired, type=String}, {name=shadow.desired.power, type=Boolean}, 
{name=deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number, type=Number}]'

JSON 语法：

aws iot update-indexing-configuration --cli-input-json \ '{
          "thingIndexingConfiguration": { "thingIndexingMode": "REGISTRY_AND_SHADOW",
          "thingConnectivityIndexingMode": "STATUS", 
          "deviceDefenderIndexingMode": "VIOLATIONS",
          "namedShadowIndexingMode": "ON",
          "filter": { "namedShadowNames": ["namedShadow1"], "geoLocations": [{"name": "shadow.name.namedShadow1.reported.location", "order": "LonLat"}], "connectivity": {"includeSocketInformation": ["GET_THING_CONNECTIVITY_DATA"]}},
          "customFields": [ { "name": "shadow.desired.power", "type": "Boolean" }, 
          {"name": "attributes.version", "type": "Number"}, 
          {"name": "shadow.name.namedShadow1.desired.DefaultDesired", "type": "String"}, 
          {"name": "deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number", "type": "Number"} ] } }'

此命令不会生成任何输出。

要检查事物索引状态，请运行 describe-index CLI 命令：

aws iot describe-index --index-name "AWS_Things"

describe-index 命令的输出如下所示：

{
    "indexName": "AWS_Things",
    "indexStatus": "ACTIVE",
    "schema": "MULTI_INDEXING_MODE"
}

要获取事物索引配置详细信息，请运行 get-indexing-configuration CLI 命令：

aws iot get-indexing-configuration

get-indexing-configuration 命令的输出如下所示：

{
    "thingIndexingConfiguration": {
        "thingIndexingMode": "REGISTRY_AND_SHADOW",
        "thingConnectivityIndexingMode": "STATUS",
        "deviceDefenderIndexingMode": "VIOLATIONS",
        "namedShadowIndexingMode": "ON",
        "managedFields": [
            {
                "name": "connectivity.keepAliveDuration",
                "type": "Number"
            },
            {
                "name": "connectivity.version",
                "type": "Number"
            },
            {
                "name": "deviceDefender.*.*.metricName",
                "type": "String"
            },
            {
                "name": "connectivity.connected",
                "type": "Boolean"
            },
            {
                "name": "shadow.version",
                "type": "Number"
            },
            {
                "name": "deviceDefender.*.*.lastViolationTime",
                "type": "Number"
            },
            {
                "name": "deviceDefender.*.*.inViolation",
                "type": "Boolean"
            },
            {
                "name": "thingName",
                "type": "String"
            },
            {
                "name": "deviceDefender.version",
                "type": "Number"
            },
            {
                "name": "shadow.name.*.version",
                "type": "Number"
            },
            {
                "name": "registry.version",
                "type": "Number"
            },
            {
                "name": "connectivity.sessionExpiry",
                "type": "Number"
            },
            {
                "name": "registry.thingTypeName",
                "type": "String"
            },
            {
                "name": "deviceDefender.violationCount",
                "type": "Number"
            },
            {
                "name": "connectivity.timestamp",
                "type": "Number"
            },
            {
                "name": "connectivity.clientId",
                "type": "String"
            },
            {
                "name": "thingId",
                "type": "String"
            },
            {
                "name": "shadow.name.*.hasDelta",
                "type": "Boolean"
            },
            {
                "name": "registry.thingGroupNames",
                "type": "String"
            },
            {
                "name": "shadow.hasDelta",
                "type": "Boolean"
            },
            {
                "name": "connectivity.cleanSession",
                "type": "Boolean"
            },
            {
                "name": "connectivity.disconnectReason",
                "type": "String"
            }
        ],
        "customFields": [
            {
                "name": "attributes.version",
                "type": "Number"
            },
            {
                "name": "shadow.desired.power",
                "type": "Boolean"
            },
            {
                "name": "shadow.name.namedShadow1.desired.DefaultDesired",
                "type": "String"
            },
            {
                "name": "deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number",
                "type": "Number"
            }
        ],
        "filter": {
            "namedShadowNames": [
                "namedShadow1"
            ],
            "geoLocations": [
                {
                    "name": "shadow.name.namedShadow1.reported.location",
                    "order": "LonLat"
                }
            ],
            "connectivity": {
                "includeSocketInformation": [
                    "GET_THING_CONNECTIVITY_DATA"
                ]
            }
        }
    },
    "thingGroupIndexingConfiguration": {
        "thingGroupIndexingMode": "OFF"
    }
}

要更新自定义字段，可以运行 update-indexing-configuration 命令。示例如下：

aws iot update-indexing-configuration --thing-indexing-configuration
          'thingIndexingMode=REGISTRY_AND_SHADOW,customFields=[{name=attributes.version,type=Number},{name=attributes.color,type=String},{name=shadow.desired.power,type=Boolean},{name=shadow.desired.intensity,type=Number}]'

此命令已将 shadow.desired.intensity 添加到索引配置中。

重建索引后，您可以对新添加的字段、搜索注册表数据、影子数据和事物连接状态数据使用聚合查询。

更改索引模式时，请使用新的索引模式以确保所有自定义字段均有效。例如，如果从 REGISTRY_AND_SHADOW 模式开始使用名为 shadow.desired.temperature 的自定义字段，则必须先删除 shadow.desired.temperature 自定义字段，然后再将索引模式更改为 REGISTRY。如果您的索引配置包含未通过索引模式建立索引的自定义字段，则更新失败。

描述事物索引

以下命令说明了如何使用 describe-index CLI 命令来检索事物索引的当前状态。

aws iot describe-index --index-name "AWS_Things"

命令的响应如下所示：

{
    "indexName": "AWS_Things", 
    "indexStatus": "BUILDING", 
    "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS"
}

首次为舰队编制索引时， Amazon IoT 会生成索引。如果 indexStatus 处于 BUILDING 状态，您无法查询索引。事物索引的 schema 指示将对什么类型的数据 (REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS) 建立索引。

更改索引的配置会导致重新生成索引。此过程中的 indexStatus 为 REBUILDING。在重建期间，您可以对事物索引中的数据运行查询。例如，如果您将索引配置从 REGISTRY 更改为 REGISTRY_AND_SHADOW，同时正在重新生成索引，则您可以查询注册表数据，包括最新的更新。但是，在重新生成操作完成之前，无法查询影子数据。生成或重新生成索引所需的时间量取决于数据量。

根据配置的数据来源，您可能在模式字段中看到不同的值。下表显示了不同的模式值和相应的说明：

查询事物索引

使用 search-index CLI 命令可查询索引中的数据。

aws iot search-index --index-name "AWS_Things" --query-string
          "thingName:mything*"

{
  "things": [
    {
      "thingName": "mything1",
      "thingGroupNames": ["mygroup1"],
      "thingId": "a4b9f759-b0f2-4857-8a4b-967745ed9f4e",
      "attributes": {
        "attribute1": "abc"
      },
      "connectivity": {
        "connected": false,
        "timestamp": 1556649874716,
        "disconnectReason": "CONNECTION_LOST",
        "clientId": "mything1",
        "keepAliveDuration": 60,
        "cleanSession": false,
        "sessionExpiry": 3600
      }
    },
    {
      "thingName": "mything2",
      "thingTypeName": "MyThingType",
      "thingGroupNames": ["mygroup1", "mygroup2"],
      "thingId": "01014ef9-e97e-44c6-985a-d0b06924f2af",
      "attributes": {
        "model": "1.2",
        "country": "usa"
      },
      "shadow": {
        "desired": {
          "location": "new york",
          "myvalues": [3, 4, 5]
        },
        "reported": {
          "location": "new york",
          "myvalues": [1, 2, 3],
          "stats": {
            "battery": 78
          }
        },
        "metadata": {
          "desired": {
            "location": { "timestamp": 123456789 },
            "myvalues": { "timestamp": 123456789 }
          },
          "reported": {
            "location": { "timestamp": 34535454 },
            "myvalues": { "timestamp": 34535454 },
            "stats": {
              "battery": { "timestamp": 34535454 }
            }
          }
        },
        "version": 10,
        "timestamp": 34535454
      },
      "connectivity": {
        "connected": true,
        "timestamp": 1556649855046,
        "clientId": "mything2",
        "keepAliveDuration": 60,
        "cleanSession": true
      }
    }
  ],
  "nextToken": "AQFCuvk7zZ3D9pOYMbFCeHbdZ+h=G"
}

在 JSON 响应中，"connectivity"（由thingConnectivityIndexingMode=STATUS设置启用）提供了设备的连接状态、时间戳、断开连接原因、客户端 ID、保持连接持续时间、清理会话标志和会话到期时间。出于 CONNECTION_LOST 原因，设备 "mything1" 在 POSIX 时间 1556649874716 断开连接 (false)。有关断开原因的更多信息，请参阅生命周期事件。

"connectivity": {
  "connected": false,
  "timestamp": 1556649874716,
  "disconnectReason": "CONNECTION_LOST",
  "clientId": "mything1",
  "keepAliveDuration": 60,
  "cleanSession": false,
  "sessionExpiry": 3600
}

设备 "mything2" 在 POSIX 时间 1556649855046 连接 (true)：

"connectivity": {
  "connected": true,
  "timestamp": 1556649855046,
  "clientId": "mything2",
  "keepAliveDuration": 60,
  "cleanSession": true
}

时间戳以自纪元以来的毫秒数表示，因此 1556649855046 表示 2019 年 4 月 30 日星期二上午 6:44:15.046（UTC）。

限制和局限性

AWS_Things 具有这些限制。

Authorization

您可以在 Amazon IoT 策略操作中将事物索引或事物（用于 GetThingConnectivityData 操作）指定为 Amazon 资源名称 (ARN)，如下所示。