Skip to content

InstalledComponent

Source code in docs_src/capo_greengrassv2/types/installed_component.py
class InstalledComponent(TypedDict, closed=True):
    component_name: NotRequired[
        "capo_greengrassv2.types.component_name_string.ComponentNameString"
    ]
    """<p>The name of the component.</p>"""
    component_version: NotRequired[
        "capo_greengrassv2.types.component_version_string.ComponentVersionString"
    ]
    """<p>The version of the component.</p>"""
    lifecycle_state: NotRequired[
        "capo_greengrassv2.types.installed_component_lifecycle_state.InstalledComponentLifecycleState"
    ]
    """<p>The lifecycle state of the component.</p>"""
    lifecycle_state_details: NotRequired[
        "capo_greengrassv2.types.lifecycle_state_details.LifecycleStateDetails"
    ]
    """<p>A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.</p>"""
    is_root: "capo_greengrassv2.types.is_root.IsRoot"
    """<p>Whether or not the component is a root component.</p>"""
    last_status_change_timestamp: NotRequired[
        "capo_greengrassv2.types.timestamp.Timestamp"
    ]
    """<p>The status of how current the data is.</p> <p>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.</p>"""
    last_reported_timestamp: NotRequired["capo_greengrassv2.types.timestamp.Timestamp"]
    """<p>The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.</p> <p>A component does not need to see a state change for this field to update.</p>"""
    last_installation_source: NotRequired[
        "capo_greengrassv2.types.non_empty_string.NonEmptyString"
    ]
    """<p>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 <code>LOCAL</code>.</p> <note> <p>Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.</p> </note>"""
    lifecycle_status_codes: NotRequired[
        "capo_greengrassv2.types.installed_component_lifecycle_status_code_list.InstalledComponentLifecycleStatusCodeList"
    ]
    """<p>The status codes that indicate the reason for failure whenever the <code>lifecycleState</code> has an error or is in a broken state.</p> <note> <p>Greengrass nucleus v2.8.0 or later is required to get an accurate <code>lifecycleStatusCodes</code> response. This response can be inaccurate in earlier Greengrass nucleus versions.</p> </note>"""

component_name instance-attribute

component_name: NotRequired[ComponentNameString]

The name of the component.

component_version instance-attribute

component_version: NotRequired[ComponentVersionString]

The version of the component.

is_root instance-attribute

is_root: IsRoot

Whether or not the component is a root component.

last_installation_source instance-attribute

last_installation_source: NotRequired[NonEmptyString]

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.

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

last_reported_timestamp instance-attribute

last_reported_timestamp: NotRequired[Timestamp]

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.

last_status_change_timestamp instance-attribute

last_status_change_timestamp: NotRequired[Timestamp]

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.

lifecycle_state instance-attribute

lifecycle_state: NotRequired[InstalledComponentLifecycleState]

The lifecycle state of the component.

lifecycle_state_details instance-attribute

lifecycle_state_details: NotRequired[LifecycleStateDetails]

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

lifecycle_status_codes instance-attribute

lifecycle_status_codes: NotRequired[InstalledComponentLifecycleStatusCodeList]

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

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.