Amazon IoT Greengrass Version 1 no longer receives feature updates, and will receive only security patches and bug fixes until June 30, 2023. For more information, see the Amazon IoT Greengrass V1 maintenance policy. We strongly recommend that you migrate to Amazon IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
UpdateConnectivityInfo
Updates the connectivity information for the core. Client devices that belong to the group that has this core receive this information to find the location of the core and connect to it.
URI: PUT
/greengrass/things/ThingName/connectivityInfo
Produces: application/json
CLI:
aws greengrass update-connectivity-info \ --thing-name <value> \ [--connectivity-info <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "ThingName": "string", "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": "int32-integer", "Metadata": "string" } ] }
Parameters:
- ThingName
-
The thing name.
where used: path; required: true
type: string
- UpdateConnectivityInfoRequestBody
-
The connectivity information.
where used: body; required:
{ "ConnectivityInfo": [ { "Id": "string", "HostAddress": "string", "PortNumber": 0x01, "Metadata": "string" } ] }schema:
-
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 address.
type: string
- PortNumber
-
The port of the Greengrass core, usually 8883.
type: integer
format: int32
- Metadata
-
Metadata for this endpoint.
type: string
Responses:
- 200
-
Success.
UpdateConnectivityInfoResponse
{ "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.
{ "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