Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1429208152.7 KB

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

get/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

Path parameters

coreDeviceThingNamestring required

The name of the core device. This is also the name of the IoT thing.

Query parameters

maxResultsinteger

The maximum number of results to be returned per paginated request.

nextTokenstring

The token to be used for the next set of paginated results.

topologyFilter'ALL' | 'ROOT'
<p>The filter for the list of components. Choose from the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all components installed on the core device.</p> </li> <li> <p> <code>ROOT</code> – The list includes only <i>root</i> 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.</p> </li> </ul> <p>Default: <code>ROOT</code> </p>

Response

Success

nextTokenstring

The token for the next set of results, or null if there are no additional results.