WorkflowStepMetadata
Runtime details and status for the workflow step.
Contents
- action
-
The step action name.
Type: String
Pattern:
^[A-Za-z][A-Za-z0-9-_]{1,99}$Required: No
- attemptNumber
-
The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- description
-
Description of the workflow step.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
- endTime
-
The timestamp when the workflow step finished.
Type: String
Required: No
- inputs
-
Input parameters that Image Builder provides for the workflow step.
Type: String
Required: No
- maxAttempts
-
The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- message
-
Detailed output message that the workflow step provides at runtime.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
- name
-
The name of the workflow step.
Type: String
Pattern:
^[A-Za-z][A-Za-z0-9-_]{1,99}$Required: No
- outputs
-
The file names that the workflow step created as output for this runtime instance of the workflow.
Type: String
Required: No
- rollbackStatus
-
Reports on the rollback status of the step, if applicable.
Type: String
Valid Values:
RUNNING | COMPLETED | SKIPPED | FAILEDRequired: No
- startTime
-
The timestamp when the workflow step started.
Type: String
Required: No
- status
-
Runtime status for the workflow step.
Type: String
Valid Values:
PENDING | SKIPPED | RUNNING | COMPLETED | FAILED | CANCELLEDRequired: No
- stepExecutionId
-
A unique identifier for the workflow step, assigned at runtime.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
