Skip to content

GetThingConnectivityDataRequest

Source code in docs_src/capo_iot/types/get_thing_connectivity_data_request.py 
12
13
14
15
16
class GetThingConnectivityDataRequest(TypedDict, closed=True):
    thing_name: "capo_iot.types.connectivity_api_thing_name.ConnectivityApiThingName"
    """<p>The name of your IoT thing.</p>"""
    include_socket_information: NotRequired["capo_iot.types.boolean.Boolean"]
    """<p>Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp, vpcEndpointId) should be included in the GetThingConnectivityData response. Set to <code>true</code> to include socket information. Set to <code>false</code> to omit socket information. By default, this is set to <code>false</code>.</p>"""

include_socket_information instance-attribute 

include_socket_information: NotRequired[Boolean]

Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp, vpcEndpointId) should be included in the GetThingConnectivityData response. Set to true to include socket information. Set to false to omit socket information. By default, this is set to false.

thing_name instance-attribute 

thing_name: ConnectivityApiThingName

The name of your IoT thing.