AWS iot documentation change
Summary
Updated documentation for AWS IoT fleet indexing: 1) Fixed markdown formatting hyphens, 2) Removed GA release note section, 3) Added new connectivity fields (clientId, keepAliveDuration, cleanSession, sessionExpiry) to indexed attributes, 4) Updated section headers and links
Security assessment
The change adds documentation for new indexed connectivity fields including clientId and session parameters which are security-relevant attributes. However, there's no evidence of a specific security vulnerability being addressed. The additions enhance security documentation by exposing more connection details for monitoring.
Diff
diff --git a/iot/latest/developerguide/managing-fleet-index.md b/iot/latest/developerguide/managing-fleet-index.md index b7916e8c4..e6b0a9331 100644 --- a//iot/latest/developerguide/managing-fleet-index.md +++ b//iot/latest/developerguide/managing-fleet-index.md @@ -17 +17 @@ The index created for all of your things is called `AWS_Things`. Thing indexing -**Registry** -AWS IoT provides a registry that helps you manage things. You can add the registry data to your fleet indexing configuration to search for devices based on the thing names, descriptions, and other registry attributes. For more information about the registry, see [How to manage things with the registry](./thing-registry.html). +**Registry** \- AWS IoT provides a registry that helps you manage things. You can add the registry data to your fleet indexing configuration to search for devices based on the thing names, descriptions, and other registry attributes. For more information about the registry, see [How to manage things with the registry](./thing-registry.html). @@ -19 +19 @@ The index created for all of your things is called `AWS_Things`. Thing indexing -**Shadow** -The [AWS IoT Device Shadow service](./iot-device-shadows.html) provides shadows that help you store your device state data. Thing indexing supports both classic unnamed shadows and named shadows. To index named shadows, activate your named shadow settings and specify your shadow names in thing indexing configuration. By default, you can add up to 10 shadow names per AWS account. To see how to increase the number of shadow names limit, see [AWS IoT Device Management Quotas](https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits) in the _AWS General Reference_. +**Shadow** \- The [AWS IoT Device Shadow service](./iot-device-shadows.html) provides shadows that help you store your device state data. Thing indexing supports both classic unnamed shadows and named shadows. To index named shadows, activate your named shadow settings and specify your shadow names in thing indexing configuration. By default, you can add up to 10 shadow names per AWS account. To see how to increase the number of shadow names limit, see [AWS IoT Device Management Quotas](https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits) in the _AWS General Reference_. @@ -25 +25 @@ To add named shadows for indexing: - * If you use the AWS Command Line Interface (AWS CLI), set `namedShadowIndexingMode` to be `ON`, and specify shadow names in [`IndexingFilter`](https://docs.aws.amazon.com//iot/latest/apireference/API_IndexingFilter.html). To see example CLI commands, see [Manage thing indexing](./managing-index.html#enable-index). + * If you use the AWS Command Line Interface (AWS CLI), set `namedShadowIndexingMode` to be `ON`, and specify shadow names in [`IndexingFilter`](https://docs.aws.amazon.com//iot/latest/apireference/API_IndexingFilter.html). To see example CLI commands, see [Managing thing indexing](./managing-index.html#enable-index). @@ -30,4 +29,0 @@ To add named shadows for indexing: -###### Important - -July 20, 2022 is the General Availability (GA) release of the AWS IoT Device Management fleet indexing integration with AWS IoT Core named shadows and AWS IoT Device Defender detect violations. With this GA release, you can index specific named shadows by specifying shadow names. If you added your named shadows for indexing during this feature's public preview period from November 30, 2021 to July 19, 2022, we encourage you to reconfigure your fleet indexing settings and choose specific shadow names to reduce indexing cost and optimize performance. - @@ -36 +32 @@ For more information about shadows, see [AWS IoT Device Shadow service](./iot-de -**Connectivity** -Device connectivity data helps you identify the connection status of your devices. This connectivity data is driven by [lifecycle events](./life-cycle-events.html). When a client connects or disconnects, AWS IoT publishes lifecycle events with messages to MQTT topics. A connect or disconnect message can be a list of JSON elements that provide details of the connection status. For more information about device connectivity, see [Lifecycle events](./life-cycle-events.html). +**Connectivity** \- Device connectivity data helps you identify the connection status of your devices. This connectivity data is driven by [lifecycle events](./life-cycle-events.html). When a client connects or disconnects, AWS IoT publishes lifecycle events with messages to MQTT topics. A connect or disconnect message can be a list of JSON elements that provide details of the connection status, including the client ID, keep-alive duration, clean session flag, and session expiry. For more information about device connectivity, see [Lifecycle events](./life-cycle-events.html). @@ -38 +34 @@ For more information about shadows, see [AWS IoT Device Shadow service](./iot-de -**Device Defender violations** -AWS IoT Device Defender violations data helps identify anomalous device behaviors against the normal behaviors that you define in a Security Profile. A Security Profile contains a set of expected device behaviors. Each behavior uses a metric that specifies the normal behavior of your devices. For more information about Device Defender violations, see [AWS IoT Device Defender detect](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-detect.html). +**Device Defender violations** \- AWS IoT Device Defender violations data helps identify anomalous device behaviors against the normal behaviors that you define in a Security Profile. A Security Profile contains a set of expected device behaviors. Each behavior uses a metric that specifies the normal behavior of your devices. For more information about Device Defender violations, see [AWS IoT Device Defender detect](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-detect.html). @@ -84 +80,5 @@ The following lists managed fields for thing indexing: - {name:connectivity.disconnectReason, type:String} + {name:connectivity.disconnectReason, type:String}, + {name:connectivity.clientId, type:String}, + {name:connectivity.keepAliveDuration, type:Number}, + {name:connectivity.cleanSession, type:Boolean}, + {name:connectivity.sessionExpiry, type:Number} @@ -124,4 +124 @@ You can aggregate thing attributes, Device Shadow data, and Device Defender viol - * **Custom field names** - - - +**Custom field names** @@ -135,4 +132 @@ If there' a type inconsistency between a custom field in your configuration and - * **Custom field types** - - - +**Custom field types** @@ -150 +144 @@ Fleet indexing -Manage thing indexing +Managing thing indexing