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 in the Amazon IoT Greengrass service.

Contents

componentState

The state of the component.

Type: String

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

Required: No

errors

A dictionary of errors that communicate why the component is in an error state. For example, if Amazon IoT Greengrass can't access an artifact for the component, 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.

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: