Greengrass / Client / update_connectivity_info

update_connectivity_info#

Greengrass.Client.update_connectivity_info(**kwargs)#

Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

See also: AWS API Documentation

Request Syntax

response = client.update_connectivity_info(
    ConnectivityInfo=[
        {
            'HostAddress': 'string',
            'Id': 'string',
            'Metadata': 'string',
            'PortNumber': 123
        },
    ],
    ThingName='string'
)
Parameters:

  • ConnectivityInfo (list) –

    A list of connectivity info.

    • (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.

  • ThingName (string) – [REQUIRED] The thing name.

Return type:

dict

Returns:

Response Syntax

{
    'Message': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) – success

    • Message (string) – A message about the connectivity info update request.

    • Version (string) – The new version of the connectivity info.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException

  • Greengrass.Client.exceptions.InternalServerErrorException