Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . greengrass ]

get-connectivity-info

Description

Retrieves the connectivity information for a core.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Examples

To get the connectivity information for a Greengrass core

The following get-connectivity-info example displays 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.

aws greengrass get-connectivity-info \
    --thing-name "MyGroup_Core"

Output:

{
    "ConnectivityInfo": [
        {
            "Metadata": "",
            "PortNumber": 8883,
            "HostAddress": "127.0.0.1",
            "Id": "AUTOIP_127.0.0.1_0"
        },
        {
            "Metadata": "",
            "PortNumber": 8883,
            "HostAddress": "192.168.1.3",
            "Id": "AUTOIP_192.168.1.3_1"
        },
        {
            "Metadata": "",
            "PortNumber": 8883,
            "HostAddress": "::1",
            "Id": "AUTOIP_::1_2"
        },
        {
            "Metadata": "",
            "PortNumber": 8883,
            "HostAddress": "fe80::1e69:ed93:f5b:f6d",
            "Id": "AUTOIP_fe80::1e69:ed93:f5b:f6d_3"
        }
    ]
}

Output

ConnectivityInfo -> (list)

Connectivity info list.

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

Message -> (string)

A message about the connectivity info request.