[ aws . greengrass ]



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

See ‘aws help’ for descriptions of global parameters.


[--connectivity-info <value>]
--thing-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--connectivity-info (list) A list of connectivity info.(structure)

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.

Shorthand Syntax:

HostAddress=string,Id=string,Metadata=string,PortNumber=integer ...

JSON Syntax:

    "HostAddress": "string",
    "Id": "string",
    "Metadata": "string",
    "PortNumber": integer

--thing-name (string) The thing name.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


To update the connectivity information for a Greengrass core

The following update-connectivity-info example changes the endpoints that devices can use to connect to the specified Greengrass core. Connectivity information is a list of IP addresses or domain names, with corresponding port numbers and optional customer-defined metadata. You might need to update connectivity information when the local network changes.

aws greengrass update-connectivity-info \
    --thing-name "MyGroup_Core" \
    --connectivity-info "[{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"\",\"Id\":\"localhost_127.0.0.1_0\"},{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"\",\"Id\":\"localIP_192.168.1.3\"}]"


    "Version": "312de337-59af-4cf9-a278-2a23bd39c300"


Message -> (string)

A message about the connectivity info update request.

Version -> (string)

The new version of the connectivity info.