Skip to content

ThingConnectivity

Source code in docs_src/capo_iot/types/thing_connectivity.py
class ThingConnectivity(TypedDict, closed=True):
    connected: NotRequired["capo_iot.types.boolean.Boolean"]
    """<p>True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.</p>"""
    timestamp: NotRequired[
        "capo_iot.types.connectivity_timestamp.ConnectivityTimestamp"
    ]
    """<p>The epoch time (in milliseconds) when the thing last connected or disconnected.</p>"""
    disconnect_reason: NotRequired["capo_iot.types.disconnect_reason.DisconnectReason"]
    """<p>The reason that the client is disconnected.</p>"""
    keep_alive_duration: NotRequired[
        "capo_iot.types.keep_alive_duration.KeepAliveDuration"
    ]
    """<p>The keep-alive interval in seconds that the client specified when establishing the connection.</p>"""
    clean_session: NotRequired["capo_iot.types.boolean.Boolean"]
    """<p>Indicates whether the client is using a clean session. Returns <code>true</code> for clean sessions.</p>"""
    session_expiry: NotRequired["capo_iot.types.session_expiry.SessionExpiry"]
    """<p>The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.</p>"""
    client_id: NotRequired["capo_iot.types.client_id.ClientId"]
    """<p>The unique identifier of the MQTT client.</p>"""

clean_session instance-attribute

clean_session: NotRequired[Boolean]

Indicates whether the client is using a clean session. Returns true for clean sessions.

client_id instance-attribute

client_id: NotRequired[ClientId]

The unique identifier of the MQTT client.

connected instance-attribute

connected: NotRequired[Boolean]

True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

disconnect_reason instance-attribute

disconnect_reason: NotRequired[DisconnectReason]

The reason that the client is disconnected.

keep_alive_duration instance-attribute

keep_alive_duration: NotRequired[KeepAliveDuration]

The keep-alive interval in seconds that the client specified when establishing the connection.

session_expiry instance-attribute

session_expiry: NotRequired[SessionExpiry]

The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.

timestamp instance-attribute

timestamp: NotRequired[ConnectivityTimestamp]

The epoch time (in milliseconds) when the thing last connected or disconnected.