Skip to content

AttributePayload

Used by
Source code in docs_src/capo_iot/types/attribute_payload.py 
12
13
14
15
16
class AttributePayload(TypedDict, closed=True):
    attributes: NotRequired["capo_iot.types.attributes.Attributes"]
    r"""<p>A JSON string containing up to three key-value pair in JSON format. For example:</p> <p> <code>{\"attributes\":{\"string1\":\"string2\"}}</code> </p>"""
    merge: "capo_iot.types.flag.Flag"
    """<p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p> </note>"""

attributes instance-attribute 

attributes: NotRequired[Attributes]

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

merge instance-attribute 

merge: Flag

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.