View a markdown version of this page

RegionFailure - EC2 Image Builder
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 (PDF).

RegionFailure

Contains details about a distribution or image configuration failure for a single Region.

Contents

errorMessage

The error message for the failure in the Region.

Type: String

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

Required: No

imageConfigurationStep

The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.

Type: String

Valid Values: ASSOCIATE_LICENSES | UPDATE_LAUNCH_TEMPLATES | PUT_SSM_PARAMETERS | UPDATE_FAST_LAUNCH_CONFIGURATIONS | EXPORT_AMI

Required: No

region

The Region where the failure occurred.

Type: String

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

Required: No

status

The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

Type: String

Valid Values: FAILED | CANCELLED | TIMED_OUT

Required: No

targetAccountId

The account ID of the account that the image was distributed to in the Region.

Type: String

Pattern: ^[0-9]{12}$

Required: No

See Also

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