View a markdown version of this page

ImageState - EC2 Image Builder

ImageState

Image status and the reason for that status.

Contents

failureContext

The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.

Type: ImageFailureContext object

Required: No

reason

The reason for the status of the image.

Type: String

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

Required: No

status

The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.

Type: String

Valid Values: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED | DISABLED

Required: No

See Also

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