AWS iot-mi documentation change
Summary
Updated terminology, removed preview notice, restructured content, and simplified device type categorization. Changed 'managedThing' to 'Managed Thing' and removed sections about customer roles and tagging limitations.
Security assessment
The changes focus on documentation clarity and feature updates rather than addressing security vulnerabilities. The removal of the tagging limitation note does not explicitly introduce or resolve a security issue, and there is no mention of security controls, vulnerabilities, or mitigations in the diff.
Diff
diff --git a/iot-mi/latest/devguide/what-is-managedintegrations.md b/iot-mi/latest/devguide/what-is-managedintegrations.md index e6b76720f..1cbd87d90 100644 --- a//iot-mi/latest/devguide/what-is-managedintegrations.md +++ b//iot-mi/latest/devguide/what-is-managedintegrations.md @@ -5,3 +5 @@ -Are you a first-time managed integrations user?Managed integrations overviewWho is the managed integrations customer?Managed integrations terminology - -Managed integrations for AWS IoT Device Management is in preview release and is subject to change. For access, contact us from the [managed integrations console](https://console.aws.amazon.com/iot/home#/managed-integrations/intro). +Are you a first-time managed integrations user?Managed integrations overviewManaged integrations terminology @@ -11 +9 @@ Managed integrations for AWS IoT Device Management is in preview release and is -With managed integrations a feature of AWS IoT Device Management, developers can automate device setup workflows and support interoperability across many devices, regardless of device vendor or connectivity protocol. They can use a single user-interface to control, manage, and operate a range of devices. +Managed integrations for AWS IoT Device Management helps IoT solution providers unify the control and management of IoT devices from hundreds of manufacturers. You can use managed integrations to automate device setup workflows and to support interoperability across many devices, regardless of device vendor or connectivity protocol. This allows solution providers to use a single user interface and set of APIs to control, manage, and operate a range of devices. @@ -19,2 +16,0 @@ With managed integrations a feature of AWS IoT Device Management, developers can - * Who is the managed integrations customer? - @@ -30 +26 @@ If you are a first-time user of managed integrations, we recommend that you begi - * [Setting up managed integrations](./setting-up.html) + * [Set up managed integrations](./setting-up.html) @@ -32 +28 @@ If you are a first-time user of managed integrations, we recommend that you begi - * [Getting started with managed integrations for AWS IoT Device Management](./getting-started.html) + * [Get started with managed integrations for AWS IoT Device Management](./getting-started.html) @@ -39 +35 @@ If you are a first-time user of managed integrations, we recommend that you begi -The following image provides a high-level overview of the managed integrations feature: +The following image provides a high-level overview of managed integrations @@ -43,30 +38,0 @@ The following image provides a high-level overview of the managed integrations f -###### Note - -The managed integrations for AWS IoT Device Management doesn’t support tagging at this time. This means you won’t be able to include resources from this feature in your organization’s tagging policies. For more information, see [Tagging use cases](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-use-cases.html) in the _AWS Whitepapers_. - -## Who is the managed integrations customer? - -A customer of managed integrations will use the feature to automate the device setup process and offer interoperability support across many devices, regardless of device vendor or connectivity protocol. These solution providers offer an integrated feature for devices and partner with hardware manufacturers to extend the range of their offerings. Customers will be able to interact with devices using a data model that is defined by AWS. - -Refer to the following table for the different roles within managed integrations: - -Role | Responsibilities ----|--- -**Manufacturer** | - - * Manufacturing devices. - * Registering device profiles with managed integrations. - - -**End-user** | - - * Managing the devices at their home that connects to managed integrations. - - -**Customer** | - - * Building a separate solution to setup and control their specific devices that communicates with managed integrations. - * Providing services to their own customers and end-users. - - - @@ -79 +45 @@ Within managed integrations, there are many concepts and terms critical to under -An important concept to understand for managed integrations is a `managedThing` compared to an AWS IoT Core thing. +An important concept to understand for managed integrations is a _Managed Thing_ compared to an AWS IoT Core thing. @@ -83,12 +49 @@ An important concept to understand for managed integrations is a `managedThing` - * _Managed integrations`managedThing`_: With a `managedThing`, we provide an abstraction to simplify device interactions and do not require the developer to create items such as rules, actions, MQTT Topics, and policies. - - - - -### Device types - -Managed integrations manages many types of devices. Those types of devices fall within one of the below three categories: - - * _Direct-connected devices_ : This type of device directly connects to an managed integrations endpoint. Typically, these devices are built and managed by device manufacturers that include the managed integrations device SDK for the direct connectivity. - - * _Hub-connected devices_ : These devices connect to managed integrations through a hub running the managed integrations Hub SDK, which manages device discovery, onboarding, and control functions. End-users can onboard these devices using button press initiation or barcode scanning. + * _Managed integrations Managed Thing_ : With a Managed Thing, we provide an abstraction to simplify device interactions and do not require the developer to create items such as rules, actions, MQTT Topics, and policies. @@ -96 +50,0 @@ Managed integrations manages many types of devices. Those types of devices fall -The following two workflows are supported for onboarding a hub-connected device: @@ -98 +51,0 @@ The following two workflows are supported for onboarding a hub-connected device: - * An end-user initiated button press to start device discovery @@ -100,10 +52,0 @@ The following two workflows are supported for onboarding a hub-connected device: - * Barcode-based scanning to perform the device association - - * _Cloud-to-cloud devices_ : When the end-user powers on the cloud device for the first time, it must be provisioned with its respective third-party cloud provider for managed integrations to obtain its device capabilities and metadata. After completing that provisioning workflow, managed integrations can communicate with the cloud device and the third-party cloud provider on behalf of the end-user. - - - - -###### Note - -A hub is not a specific device type as listed above. Its purpose is serving the role as a controller of smart home devices and facilitating a connection between managed integrations and third-party cloud providers. It can serve the role as both a device type as listed above and as a hub. @@ -117 +60 @@ Physical devices that integrate with managed integrations may originate from a t - * _Third-party cloud provider_ : For devices that are manufactured and managed outside of managed integrations, a third-party cloud provider enables control of these devices for the end-user and managed integrations communicates with the third-party cloud provider for various workflows such as device commands. + * _Third-party cloud provider_ : For devices that are manufactured and managed outside of managed integrations, a third-party cloud provider enables control of these devices for the end user and managed integrations communicates with the third-party cloud provider for various workflows such as device commands. @@ -124 +67 @@ Physical devices that integrate with managed integrations may originate from a t -Managed integrations uses two data models for organizing data and end-to-end communication between your devices. The following terminology covers some of the key concepts for understanding those two data models: +Managed integrations uses data models for organizing data and end-to-end communication between your devices. The following terminology covers some of the key concepts for understanding those two data models: @@ -128,2 +70,0 @@ Managed integrations uses two data models for organizing data and end-to-end com - * **Node:** A device is composed of multiple nodes (adopted from AWS' implementation of the Matter Data Model ). Each node handles communication with other nodes. A node is uniquely addressable to facilitate communication. - @@ -140 +81 @@ Managed integrations uses two data models for organizing data and end-to-end com - * **Data Model:** The data layer corresponds to the data and verb elements that help support the functionality of the application. The Application operates on these data structures when there is an intent to interact with the device. For more information, see [connectedhomeip](https://github.com/project-chip/connectedhomeip) on the _GitHub_ website. + * **Data Model:** The data layer corresponds to the data and verb elements that help support the functionality of the application. The Application operates on these data structures when there is an intent to interact with the device. For more information, see [connectedhomeip](https://github.com/project-chip/connectedhomeip/tree/v1.4-branch/src/app/zap-templates/zcl/data-model/chip) on the _GitHub_ website. @@ -153 +94 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Setting up +Set up managed integrations