ImageFailureContext
Contains details about the failure when the image creation process fails. Properties appear in the failure context when the related information is available for the failure.
Contents
- componentFailure
-
The details about the component that failed, if the failure occurred while a component was running.
Type: ComponentFailureContext object
Required: No
- distributionFailure
-
The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.
Type: DistributionFailureContext object
Required: No
- failedStep
-
The name of the workflow step that failed, as it appears in the workflow document.
Type: String
Pattern:
^[A-Za-z][A-Za-z0-9-_]{1,99}$Required: No
- imageStatus
-
The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example
BUILDINGorDISTRIBUTING.Type: String
Valid Values:
PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED | DISABLEDRequired: No
- stepExecutionId
-
The unique identifier of the workflow step execution that failed.
Type: String
Pattern:
^step-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Required: No
- workflowArn
-
The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$Required: No
- workflowExecutionId
-
The unique identifier of the workflow execution that was running when the image failed.
Type: String
Pattern:
^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
