ListInstalledComponents - AWS IoT Greengrass

ListInstalledComponents

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.

Note

AWS IoT Greengrass relies on individual devices to send status updates to the AWS Cloud. If the AWS IoT Greengrass Core software isn't running on the device, or if device isn't connected to the AWS 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 AWS IoT Greengrass Core software starts

  • When the core device receives a deployment from the AWS 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 AWS IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Request Syntax

GET /greengrass/v2/coreDevices/coreDeviceThingName/installedComponents?maxResults=maxResults&nextToken=nextToken&topologyFilter=topologyFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

coreDeviceThingName

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

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

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

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

Valid Values: ALL | ROOT

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "installedComponents": [ { "componentName": "string", "componentVersion": "string", "isRoot": boolean, "lastStatusChangeTimestamp": number, "lifecycleState": "string", "lifecycleStateDetails": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

installedComponents

A list that summarizes each component on the core device.

Note

Greengrass nucleus v2.7.0 or later is required to get an accurate lastStatusChangeTimestamp response. This response can be inaccurate on earlier Greengrass nucleus versions.

Type: Array of InstalledComponent objects

nextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: