GreengrassV2 / Client / get_connectivity_info

get_connectivity_info#

GreengrassV2.Client.get_connectivity_info(**kwargs)#

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_connectivity_info(
    thingName='string'
)
Parameters:

thingName (string) –

[REQUIRED]

The name of the core device. This is also the name of the IoT thing.

Return type:

dict

Returns:

Response Syntax

{
    'connectivityInfo': [
        {
            'id': 'string',
            'hostAddress': 'string',
            'portNumber': 123,
            'metadata': 'string'
        },
    ],
    'message': 'string'
}

Response Structure

  • (dict) –

    • connectivityInfo (list) –

      The connectivity information for the core device.

      • (dict) –

        Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.

        • id (string) –

          An ID for the connectivity information.

        • hostAddress (string) –

          The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.

        • portNumber (integer) –

          The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.

        • metadata (string) –

          Additional metadata to provide to client devices that connect to this core device.

    • message (string) –

      A message about the connectivity information request.

Exceptions

  • GreengrassV2.Client.exceptions.ValidationException

  • GreengrassV2.Client.exceptions.InternalServerException