Skip to content

CloudComponentStatus

Source code in docs_src/capo_greengrassv2/types/cloud_component_status.py
class CloudComponentStatus(TypedDict, closed=True):
    component_state: NotRequired[
        "capo_greengrassv2.types.cloud_component_state.CloudComponentState"
    ]
    """<p>The state of the component version.</p>"""
    message: NotRequired["capo_greengrassv2.types.non_empty_string.NonEmptyString"]
    """<p>A message that communicates details, such as errors, about the status of the component version.</p>"""
    errors: NotRequired["capo_greengrassv2.types.string_map.StringMap"]
    """<p>A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then <code>errors</code> contains the artifact's URI as a key, and the error message as the value for that key.</p>"""
    vendor_guidance: NotRequired[
        "capo_greengrassv2.types.vendor_guidance.VendorGuidance"
    ]
    """<p>The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:</p> <ul> <li> <p> <code>ACTIVE</code> – This component version is available and recommended for use.</p> </li> <li> <p> <code>DISCONTINUED</code> – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.</p> </li> <li> <p> <code>DELETED</code> – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.</p> </li> </ul>"""
    vendor_guidance_message: NotRequired[
        "capo_greengrassv2.types.non_empty_string.NonEmptyString"
    ]
    """<p>A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.</p>"""

component_state instance-attribute

component_state: NotRequired[CloudComponentState]

The state of the component version.

errors instance-attribute

errors: NotRequired[StringMap]

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

message instance-attribute

message: NotRequired[NonEmptyString]

A message that communicates details, such as errors, about the status of the component version.

vendor_guidance instance-attribute

vendor_guidance: NotRequired[VendorGuidance]

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

  • ACTIVE – This component version is available and recommended for use.

  • DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

  • DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

vendor_guidance_message instance-attribute

vendor_guidance_message: NotRequired[NonEmptyString]

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.