| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.GreengrassV2.GetConnectivityInfo
Description
Retrieves 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 IoT Greengrass discovery API, 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 IoT Greengrass Version 2 Developer Guide.
Synopsis
- data GetConnectivityInfo = GetConnectivityInfo' {}
- newGetConnectivityInfo :: Text -> GetConnectivityInfo
- getConnectivityInfo_thingName :: Lens' GetConnectivityInfo Text
- data GetConnectivityInfoResponse = GetConnectivityInfoResponse' {}
- newGetConnectivityInfoResponse :: Int -> GetConnectivityInfoResponse
- getConnectivityInfoResponse_connectivityInfo :: Lens' GetConnectivityInfoResponse (Maybe [ConnectivityInfo])
- getConnectivityInfoResponse_message :: Lens' GetConnectivityInfoResponse (Maybe Text)
- getConnectivityInfoResponse_httpStatus :: Lens' GetConnectivityInfoResponse Int
Creating a Request
data GetConnectivityInfo Source #
See: newGetConnectivityInfo smart constructor.
Constructors
| GetConnectivityInfo' | |
Instances
newGetConnectivityInfo Source #
Arguments
| :: Text | |
| -> GetConnectivityInfo |
Create a value of GetConnectivityInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetConnectivityInfo, getConnectivityInfo_thingName - The name of the core device. This is also the name of the IoT thing.
Request Lenses
getConnectivityInfo_thingName :: Lens' GetConnectivityInfo Text Source #
The name of the core device. This is also the name of the IoT thing.
Destructuring the Response
data GetConnectivityInfoResponse Source #
See: newGetConnectivityInfoResponse smart constructor.
Constructors
| GetConnectivityInfoResponse' | |
Fields
| |
Instances
newGetConnectivityInfoResponse Source #
Create a value of GetConnectivityInfoResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectivityInfo:GetConnectivityInfoResponse', getConnectivityInfoResponse_connectivityInfo - The connectivity information for the core device.
GetConnectivityInfoResponse, getConnectivityInfoResponse_message - A message about the connectivity information request.
$sel:httpStatus:GetConnectivityInfoResponse', getConnectivityInfoResponse_httpStatus - The response's http status code.
Response Lenses
getConnectivityInfoResponse_connectivityInfo :: Lens' GetConnectivityInfoResponse (Maybe [ConnectivityInfo]) Source #
The connectivity information for the core device.
getConnectivityInfoResponse_message :: Lens' GetConnectivityInfoResponse (Maybe Text) Source #
A message about the connectivity information request.
getConnectivityInfoResponse_httpStatus :: Lens' GetConnectivityInfoResponse Int Source #
The response's http status code.