Skip to content

ThingDocument

Source code in docs_src/capo_iot/types/thing_document.py
class ThingDocument(TypedDict, closed=True):
    thing_name: NotRequired["capo_iot.types.thing_name.ThingName"]
    """<p>The thing name.</p>"""
    thing_id: NotRequired["capo_iot.types.thing_id.ThingId"]
    """<p>The thing ID.</p>"""
    thing_type_name: NotRequired["capo_iot.types.thing_type_name.ThingTypeName"]
    """<p>The thing type name.</p>"""
    thing_group_names: NotRequired[
        "capo_iot.types.thing_group_name_list.ThingGroupNameList"
    ]
    """<p>Thing group and billing group names.</p>"""
    attributes: NotRequired["capo_iot.types.attributes.Attributes"]
    """<p>The attributes.</p>"""
    shadow: NotRequired["capo_iot.types.json_document.JsonDocument"]
    """<p>The unnamed shadow and named shadow.</p> <p>For more information about shadows, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html">IoT Device Shadow service.</a> </p>"""
    device_defender: NotRequired["capo_iot.types.json_document.JsonDocument"]
    """<p>Contains Device Defender data.</p> <p>For more information about Device Defender, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html">Device Defender</a>. </p>"""
    connectivity: NotRequired["capo_iot.types.thing_connectivity.ThingConnectivity"]
    """<p>Indicates whether the thing is connected to the Amazon Web Services IoT Core service.</p>"""

attributes instance-attribute

attributes: NotRequired[Attributes]

The attributes.

connectivity instance-attribute

connectivity: NotRequired[ThingConnectivity]

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

device_defender instance-attribute

device_defender: NotRequired[JsonDocument]

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

shadow instance-attribute

shadow: NotRequired[JsonDocument]

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

thing_group_names instance-attribute

thing_group_names: NotRequired[ThingGroupNameList]

Thing group and billing group names.

thing_id instance-attribute

thing_id: NotRequired[ThingId]

The thing ID.

thing_name instance-attribute

thing_name: NotRequired[ThingName]

The thing name.

thing_type_name instance-attribute

thing_type_name: NotRequired[ThingTypeName]

The thing type name.