| 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.ListInstalledComponents
Description
Retrieves a paginated list of the components that a Greengrass core
device runs. By default, this list doesn't include components that are
deployed as dependencies of other components. To include dependencies in
the response, set the topologyFilter parameter to ALL.
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 ListInstalledComponents = ListInstalledComponents' {}
- newListInstalledComponents :: Text -> ListInstalledComponents
- listInstalledComponents_maxResults :: Lens' ListInstalledComponents (Maybe Natural)
- listInstalledComponents_nextToken :: Lens' ListInstalledComponents (Maybe Text)
- listInstalledComponents_topologyFilter :: Lens' ListInstalledComponents (Maybe InstalledComponentTopologyFilter)
- listInstalledComponents_coreDeviceThingName :: Lens' ListInstalledComponents Text
- data ListInstalledComponentsResponse = ListInstalledComponentsResponse' {}
- newListInstalledComponentsResponse :: Int -> ListInstalledComponentsResponse
- listInstalledComponentsResponse_installedComponents :: Lens' ListInstalledComponentsResponse (Maybe [InstalledComponent])
- listInstalledComponentsResponse_nextToken :: Lens' ListInstalledComponentsResponse (Maybe Text)
- listInstalledComponentsResponse_httpStatus :: Lens' ListInstalledComponentsResponse Int
Creating a Request
data ListInstalledComponents Source #
See: newListInstalledComponents smart constructor.
Constructors
| ListInstalledComponents' | |
Fields
| |
Instances
newListInstalledComponents Source #
Arguments
| :: Text | |
| -> ListInstalledComponents |
Create a value of ListInstalledComponents 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:ListInstalledComponents', listInstalledComponents_maxResults - The maximum number of results to be returned per paginated request.
ListInstalledComponents, listInstalledComponents_nextToken - The token to be used for the next set of paginated results.
$sel:topologyFilter:ListInstalledComponents', listInstalledComponents_topologyFilter - The filter for the list of components. Choose from the following
options:
ALL– The list includes all components installed on the core device.ROOT– The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.
Default: ROOT
ListInstalledComponents, listInstalledComponents_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.
Request Lenses
listInstalledComponents_maxResults :: Lens' ListInstalledComponents (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listInstalledComponents_nextToken :: Lens' ListInstalledComponents (Maybe Text) Source #
The token to be used for the next set of paginated results.
listInstalledComponents_topologyFilter :: Lens' ListInstalledComponents (Maybe InstalledComponentTopologyFilter) Source #
The filter for the list of components. Choose from the following options:
ALL– The list includes all components installed on the core device.ROOT– The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.
Default: ROOT
listInstalledComponents_coreDeviceThingName :: Lens' ListInstalledComponents Text Source #
The name of the core device. This is also the name of the IoT thing.
Destructuring the Response
data ListInstalledComponentsResponse Source #
See: newListInstalledComponentsResponse smart constructor.
Constructors
| ListInstalledComponentsResponse' | |
Fields
| |
Instances
newListInstalledComponentsResponse Source #
Create a value of ListInstalledComponentsResponse 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:installedComponents:ListInstalledComponentsResponse', listInstalledComponentsResponse_installedComponents - A list that summarizes each component on the core device.
Greengrass nucleus v2.7.0 or later is required to get an accurate
lastStatusChangeTimestamp response. This response can be inaccurate in
earlier Greengrass nucleus versions.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lastInstallationSource and lastReportedTimestamp response. This
response can be inaccurate or null in earlier Greengrass nucleus
versions.
ListInstalledComponents, listInstalledComponentsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListInstalledComponentsResponse', listInstalledComponentsResponse_httpStatus - The response's http status code.
Response Lenses
listInstalledComponentsResponse_installedComponents :: Lens' ListInstalledComponentsResponse (Maybe [InstalledComponent]) Source #
A list that summarizes each component on the core device.
Greengrass nucleus v2.7.0 or later is required to get an accurate
lastStatusChangeTimestamp response. This response can be inaccurate in
earlier Greengrass nucleus versions.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lastInstallationSource and lastReportedTimestamp response. This
response can be inaccurate or null in earlier Greengrass nucleus
versions.
listInstalledComponentsResponse_nextToken :: Lens' ListInstalledComponentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listInstalledComponentsResponse_httpStatus :: Lens' ListInstalledComponentsResponse Int Source #
The response's http status code.