get_connectivity_info

Greengrass.Client.get_connectivity_info(**kwargs)

Retrieves the connectivity information for a core.

See also: AWS API Documentation

Request Syntax

response = client.get_connectivity_info(
    ThingName='string'
)

Parameters

ThingName (string) -- [REQUIRED] The thing name.

Return type

dict

Returns

Response Syntax

{
    'ConnectivityInfo': [
        {
            'HostAddress': 'string',
            'Id': 'string',
            'Metadata': 'string',
            'PortNumber': 123
        },
    ],
    'Message': 'string'
}

Response Structure

• (dict) -- success
  • ConnectivityInfo (list) -- Connectivity info list.
    • (dict) -- Information about a Greengrass core's connectivity.
      • HostAddress (string) -- The endpoint for the Greengrass core. Can be an IP address or DNS.
      • Id (string) -- The ID of the connectivity information.
      • Metadata (string) -- Metadata for this endpoint.
      • PortNumber (integer) -- The port of the Greengrass core. Usually 8883.
  • Message (string) -- A message about the connectivity info request.

Exceptions

• Greengrass.Client.exceptions.BadRequestException
• Greengrass.Client.exceptions.InternalServerErrorException