Skip to content

GetThingConnectivityDataResponse

Source code in docs_src/capo_iot/types/get_thing_connectivity_data_response.py
class GetThingConnectivityDataResponse(TypedDict, closed=True):
    thing_name: NotRequired[
        "capo_iot.types.connectivity_api_thing_name.ConnectivityApiThingName"
    ]
    """<p>The name of your IoT thing.</p>"""
    connected: NotRequired["capo_iot.types.boolean.Boolean"]
    """<p>A Boolean that indicates the connectivity status.</p>"""
    timestamp: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The timestamp of when the device connected or disconnected.</p>"""
    disconnect_reason: NotRequired[
        "capo_iot.types.disconnect_reason_value.DisconnectReasonValue"
    ]
    """<p>The reason that the client is disconnected.</p>"""
    source_ip: NotRequired["capo_iot.types.source_ip.SourceIp"]
    """<p>The IP address of the client that initiated the connection.</p>"""
    source_port: NotRequired["capo_iot.types.source_port.SourcePort"]
    """<p>The client's source port.</p>"""
    target_ip: NotRequired["capo_iot.types.target_ip.TargetIp"]
    """<p>The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.</p>"""
    target_port: NotRequired["capo_iot.types.target_port.TargetPort"]
    """<p>The port number of the Amazon Web Services IoT Core endpoint that the client connected to.</p>"""
    vpc_endpoint_id: NotRequired["capo_iot.types.vpc_endpoint_id.VpcEndpointId"]
    """<p>The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.</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]

A Boolean that indicates the connectivity status.

disconnect_reason instance-attribute

disconnect_reason: NotRequired[DisconnectReasonValue]

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.

source_ip instance-attribute

source_ip: NotRequired[SourceIp]

The IP address of the client that initiated the connection.

source_port instance-attribute

source_port: NotRequired[SourcePort]

The client's source port.

target_ip instance-attribute

target_ip: NotRequired[TargetIp]

The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.

target_port instance-attribute

target_port: NotRequired[TargetPort]

The port number of the Amazon Web Services IoT Core endpoint that the client connected to.

thing_name instance-attribute

thing_name: NotRequired[ConnectivityApiThingName]

The name of your IoT thing.

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

The timestamp of when the device connected or disconnected.

vpc_endpoint_id instance-attribute

vpc_endpoint_id: NotRequired[VpcEndpointId]

The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.