Menu
AWS Greengrass
API Reference

/greengrass/things/ThingName/connectivityInfo

GET

GET /greengrass/things/ThingName/connectivityInfo

Operation ID: GetConnectivityInfo

Retrieves the connectivity information for a core.

Produces: application/json

Path Parameters

ThingName

The thing name.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

Copy
{ "ThingName": "string" }

Responses

200

success

GetConnectivityInfoResponse

Copy
{ "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.

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

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing 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

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing 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

PUT

PUT /greengrass/things/ThingName/connectivityInfo

Operation ID: UpdateConnectivityInfo

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.

Produces: application/json

Body Parameters

UpdateConnectivityInfoRequestBody

The connectivity information.

where used: body; required:

Copy
{ "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ] }

Information required to update a Greengrass core's connectivity.

ConnectivityInfo

A list of connectivity info.

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.

type: string

PortNumber

The port of the Greengrass core. Usually 8883.

type: integer

format: int32

Metadata

Metadata for this endpoint.

type: string

Path Parameters

ThingName

The thing name.

where used: path; required: true

type: string

CLI

Copy
aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "string" } ] }

Responses

200

success

UpdateConnectivityInfoResponse

Copy
{ "message": "string", "Version": "string" }
message

A message about the connectivity info update request.

type: string

Version

The new version of the connectivity info.

type: string

400

invalid request

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing 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

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing 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

On this page: