| 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.ListCoreDevices
Description
Retrieves a paginated list of Greengrass core devices.
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
This operation returns paginated results.
Synopsis
- data ListCoreDevices = ListCoreDevices' {}
- newListCoreDevices :: ListCoreDevices
- listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural)
- listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text)
- listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus)
- listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text)
- data ListCoreDevicesResponse = ListCoreDevicesResponse' {
- coreDevices :: Maybe [CoreDevice]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListCoreDevicesResponse :: Int -> ListCoreDevicesResponse
- listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice])
- listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text)
- listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int
Creating a Request
data ListCoreDevices Source #
See: newListCoreDevices smart constructor.
Constructors
| ListCoreDevices' | |
Fields
| |
Instances
newListCoreDevices :: ListCoreDevices Source #
Create a value of ListCoreDevices 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:maxResults:ListCoreDevices', listCoreDevices_maxResults - The maximum number of results to be returned per paginated request.
ListCoreDevices, listCoreDevices_nextToken - The token to be used for the next set of paginated results.
ListCoreDevices, listCoreDevices_status - The core device status by which to filter. If you specify this
parameter, the list includes only core devices that have this status.
Choose one of the following options:
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:thingGroupArn:ListCoreDevices', listCoreDevices_thingGroupArn - The
ARN
of the IoT thing group by which to filter. If you specify this
parameter, the list includes only core devices that have successfully
deployed a deployment that targets the thing group. When you remove a
core device from a thing group, the list continues to include that core
device.
Request Lenses
listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text) Source #
The token to be used for the next set of paginated results.
listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus) Source #
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
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.
listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text) Source #
The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.
Destructuring the Response
data ListCoreDevicesResponse Source #
See: newListCoreDevicesResponse smart constructor.
Constructors
| ListCoreDevicesResponse' | |
Fields
| |
Instances
newListCoreDevicesResponse Source #
Create a value of ListCoreDevicesResponse 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:coreDevices:ListCoreDevicesResponse', listCoreDevicesResponse_coreDevices - A list that summarizes each core device.
ListCoreDevices, listCoreDevicesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListCoreDevicesResponse', listCoreDevicesResponse_httpStatus - The response's http status code.
Response Lenses
listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice]) Source #
A list that summarizes each core device.
listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int Source #
The response's http status code.