ComponentFailureContext
Contains details about the component that caused the image creation process to fail. The details identify the first step that failed when the component ran.
Contents
- action
-
The action that the failed step runs, for example
ExecuteBash.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- componentArn
-
The Amazon Resource Name (ARN) of the component build version that failed.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$Required: No
- errorMessage
-
The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 384000.
Required: No
- phaseName
-
The name of the phase in the component document where the failure occurred, such as
build,validate, ortest.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- stepName
-
The name of the step in the component document that failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: