Skip to content

DescribeThingResponse

Source code in docs_src/capo_iot/types/describe_thing_response.py
class DescribeThingResponse(TypedDict, closed=True):
    default_client_id: NotRequired["capo_iot.types.client_id.ClientId"]
    """<p>The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.</p> <p>This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.</p>"""
    thing_name: NotRequired["capo_iot.types.thing_name.ThingName"]
    """<p>The name of the thing.</p>"""
    thing_id: NotRequired["capo_iot.types.thing_id.ThingId"]
    """<p>The ID of the thing to describe.</p>"""
    thing_arn: NotRequired["capo_iot.types.thing_arn.ThingArn"]
    """<p>The ARN of the thing to describe.</p>"""
    thing_type_name: NotRequired["capo_iot.types.thing_type_name.ThingTypeName"]
    """<p>The thing type name.</p>"""
    attributes: NotRequired["capo_iot.types.attributes.Attributes"]
    """<p>The thing attributes.</p>"""
    version: "capo_iot.types.version.Version"
    """<p>The current version of the thing record in the registry.</p> <note> <p>To avoid unintentional changes to the information in the registry, you can pass the version information in the <code>expectedVersion</code> parameter of the <code>UpdateThing</code> and <code>DeleteThing</code> calls.</p> </note>"""
    billing_group_name: NotRequired[
        "capo_iot.types.billing_group_name.BillingGroupName"
    ]
    """<p>The name of the billing group the thing belongs to.</p>"""

attributes instance-attribute

attributes: NotRequired[Attributes]

The thing attributes.

billing_group_name instance-attribute

billing_group_name: NotRequired[BillingGroupName]

The name of the billing group the thing belongs to.

default_client_id instance-attribute

default_client_id: NotRequired[ClientId]

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

thing_arn instance-attribute

thing_arn: NotRequired[ThingArn]

The ARN of the thing to describe.

thing_id instance-attribute

thing_id: NotRequired[ThingId]

The ID of the thing to describe.

thing_name instance-attribute

thing_name: NotRequired[ThingName]

The name of the thing.

thing_type_name instance-attribute

thing_type_name: NotRequired[ThingTypeName]

The thing type name.

version instance-attribute

version: Version

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.