You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 API Reference.
GetConnectivityInfo
Retrieves the connectivity information for a core.
URI: GET
/greengrass/things/
ThingName
/connectivityInfo
Produces: application/json
CLI:
aws greengrass get-connectivity-info \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ThingName": "string" }
Parameters:
- ThingName
-
The thing name.
where used: path; required: true
type: string
Responses:
- 200
-
Success.
{ "message": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ] }
-
Information about a Greengrass core's connectivity.
- message
-
A message about the connectivity info request.
type: string
- ConnectivityInfo
-
Connectivity info list.
type: array
items: ConnectivityInfo
-
Information about a Greengrass core's connectivity.
required: ["Id", "HostAddress"]
- Id
-
The ID of the connectivity information.
type: string
- HostAddress
-
The endpoint for the Greengrass core. Can be an IP address or DNS address.
type: string
- PortNumber
-
The port of the Greengrass core, usually 8883.
type: integer
format: int32
- Metadata
-
Metadata for this endpoint.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
- 500
-
Server error.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string