UpdateConnectivityInfo
Updates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the AWS IoT Greengrass discovery API, AWS IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the AWS IoT Greengrass Version 2 Developer Guide.
Request Syntax
PUT /greengrass/things/thingName/connectivityInfo HTTP/1.1
Content-type: application/json
{
"ConnectivityInfo": [
{
"HostAddress": "string",
"Id": "string",
"Metadata": "string",
"PortNumber": number
}
]
}URI Request Parameters
The request uses the following URI parameters.
- thingName
-
The name of the core device. This is also the name of the AWS IoT thing.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ConnectivityInfo
-
The connectivity information for the core device.
Type: Array of ConnectivityInfo objects
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Message": "string",
"Version": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
AWS IoT Greengrass can't process your request right now. Try again later.
HTTP Status Code: 500
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
