InstalledComponent - Amazon IoT Greengrass
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InstalledComponent

Contains information about a component on a Greengrass core device.

Contents

componentName

The name of the component.

Type: String

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

Required: No

componentVersion

The version of the component.

Type: String

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

Required: No

isRoot

Whether or not the component is a root component.

Type: Boolean

Required: No

lastInstallationSource

The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL.

Note

Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.

Type: String

Length Constraints: Minimum length of 1.

Required: No

lastReportedTimestamp

The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.

A component does not need to see a state change for this field to update.

Type: Timestamp

Required: No

lastStatusChangeTimestamp

The status of how current the data is.

This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

Type: Timestamp

Required: No

lifecycleState

The lifecycle state of the component.

Type: String

Valid Values: NEW | INSTALLED | STARTING | RUNNING | STOPPING | ERRORED | BROKEN | FINISHED

Required: No

lifecycleStateDetails

A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

Type: String

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

Required: No

lifecycleStatusCodes

The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Note

Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.

Type: Array of strings

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

Required: No

See Also

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