CloudComponentStatus - Amazon IoT Greengrass
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.

CloudComponentStatus

Contains the status of a component version in the Amazon IoT Greengrass service.

Contents

componentState

The state of the component version.

Type: String

Valid Values: REQUESTED | INITIATED | DEPLOYABLE | FAILED | DEPRECATED

Required: No

errors

A dictionary of errors that communicate why the component version is in an error state. For example, if Amazon 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.

Type: String to string map

Key Length Constraints: Minimum length of 1.

Value Length Constraints: Minimum length of 1.

Required: No

message

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

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.

Type: String

Valid Values: ACTIVE | DISCONTINUED | DELETED

Required: No

vendorGuidanceMessage

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

See Also

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