WorkflowStepMetadata ¶

class WorkflowStepMetadata(TypedDict, closed=True):
    step_execution_id: NotRequired[
        "capo_imagebuilder.types.workflow_step_execution_id.WorkflowStepExecutionId"
    ]
    """<p>A unique identifier for the workflow step, assigned at runtime.</p>"""
    name: NotRequired["capo_imagebuilder.types.workflow_step_name.WorkflowStepName"]
    """<p>The name of the workflow step.</p>"""
    description: NotRequired[
        "capo_imagebuilder.types.workflow_step_description.WorkflowStepDescription"
    ]
    """<p>Description of the workflow step.</p>"""
    action: NotRequired[
        "capo_imagebuilder.types.workflow_step_action.WorkflowStepAction"
    ]
    """<p>The step action name.</p>"""
    status: NotRequired[
        "capo_imagebuilder.types.workflow_step_execution_status.WorkflowStepExecutionStatus"
    ]
    """<p>Runtime status for the workflow step.</p>"""
    rollback_status: NotRequired[
        "capo_imagebuilder.types.workflow_step_execution_rollback_status.WorkflowStepExecutionRollbackStatus"
    ]
    """<p>Reports on the rollback status of the step, if applicable.</p>"""
    message: NotRequired[
        "capo_imagebuilder.types.workflow_step_message.WorkflowStepMessage"
    ]
    """<p>Detailed output message that the workflow step provides at runtime.</p>"""
    inputs: NotRequired[
        "capo_imagebuilder.types.workflow_step_inputs.WorkflowStepInputs"
    ]
    """<p>Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.</p>"""
    outputs: NotRequired[
        "capo_imagebuilder.types.workflow_step_outputs.WorkflowStepOutputs"
    ]
    """<p>The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.</p>"""
    start_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when the workflow step started.</p>"""
    end_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when the workflow step finished.</p>"""
    attempt_number: NotRequired[
        "capo_imagebuilder.types.workflow_step_attempt_count.WorkflowStepAttemptCount"
    ]
    """<p>The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.</p>"""
    max_attempts: NotRequired[
        "capo_imagebuilder.types.workflow_step_attempt_count.WorkflowStepAttemptCount"
    ]
    """<p>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.</p>"""