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 |
Retrieves metadata for a Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the following times:
- When the IoT Greengrass Core software starts
- When the core device receives a deployment from the Amazon Web Services Cloud
- When the status of any component on the core device becomes
BROKEN
- At a regular interval that you can configure, which defaults to 24 hours
- For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
Synopsis
- data GetCoreDevice = GetCoreDevice' {}
- newGetCoreDevice :: Text -> GetCoreDevice
- getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text
- data GetCoreDeviceResponse = GetCoreDeviceResponse' {}
- newGetCoreDeviceResponse :: Int -> GetCoreDeviceResponse
- getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime)
- getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus)
- getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text))
- getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int
Creating a Request
data GetCoreDevice Source #
See: newGetCoreDevice
smart constructor.
GetCoreDevice' | |
|
Instances
Create a value of GetCoreDevice
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:
GetCoreDevice
, getCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
Request Lenses
getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
Destructuring the Response
data GetCoreDeviceResponse Source #
See: newGetCoreDeviceResponse
smart constructor.
GetCoreDeviceResponse' | |
|
Instances
newGetCoreDeviceResponse Source #
Create a value of GetCoreDeviceResponse
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:architecture:GetCoreDeviceResponse'
, getCoreDeviceResponse_architecture
- The computer architecture of the core device.
GetCoreDevice
, getCoreDeviceResponse_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
$sel:coreVersion:GetCoreDeviceResponse'
, getCoreDeviceResponse_coreVersion
- The version of the IoT Greengrass Core software that the core device
runs. This version is equivalent to the version of the Greengrass
nucleus component that runs on the core device. For more information,
see the
Greengrass nucleus component
in the IoT Greengrass V2 Developer Guide.
GetCoreDeviceResponse
, getCoreDeviceResponse_lastStatusUpdateTimestamp
- The time at which the core device's status last updated, expressed in
ISO 8601 format.
$sel:platform:GetCoreDeviceResponse'
, getCoreDeviceResponse_platform
- The operating system platform that the core device runs.
GetCoreDeviceResponse
, getCoreDeviceResponse_status
- The status of the core device. The core device status can be:
HEALTHY
– The IoT Greengrass Core software and all components run on the core device without issue.UNHEALTHY
– The IoT Greengrass Core software or a component is in a failed state on the core device.
$sel:tags:GetCoreDeviceResponse'
, getCoreDeviceResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
$sel:httpStatus:GetCoreDeviceResponse'
, getCoreDeviceResponse_httpStatus
- The response's http status code.
Response Lenses
getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The computer architecture of the core device.
getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The name of the core device. This is also the name of the IoT thing.
getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
getCoreDeviceResponse_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime) Source #
The time at which the core device's status last updated, expressed in ISO 8601 format.
getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The operating system platform that the core device runs.
getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus) Source #
The status of the core device. The core device status can be:
HEALTHY
– The IoT Greengrass Core software and all components run on the core device without issue.UNHEALTHY
– The IoT Greengrass Core software or a component is in a failed state on the core device.
getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int Source #
The response's http status code.