Skip to content

WorkflowConfiguration

Source code in docs_src/capo_imagebuilder/types/workflow_configuration.py
class WorkflowConfiguration(TypedDict, closed=True):
    workflow_arn: "capo_imagebuilder.types.workflow_version_arn_or_build_version_arn.WorkflowVersionArnOrBuildVersionArn"
    """<p>The Amazon Resource Name (ARN) of the workflow resource.</p>"""
    parameters: NotRequired[
        "capo_imagebuilder.types.workflow_parameter_list.WorkflowParameterList"
    ]
    """<p>Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.</p>"""
    parallel_group: NotRequired["capo_imagebuilder.types.parallel_group.ParallelGroup"]
    """<p>Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.</p>"""
    on_failure: NotRequired[
        "capo_imagebuilder.types.on_workflow_failure.OnWorkflowFailure"
    ]
    """<p>The action to take if the workflow fails. With <code>CONTINUE</code>, a failed workflow is logged and image creation proceeds to the next workflow. If you don't set a value, the image build fails when the workflow fails. You can only set this property for test workflows.</p>"""

on_failure instance-attribute

on_failure: NotRequired[OnWorkflowFailure]

The action to take if the workflow fails. With CONTINUE, a failed workflow is logged and image creation proceeds to the next workflow. If you don't set a value, the image build fails when the workflow fails. You can only set this property for test workflows.

parallel_group instance-attribute

parallel_group: NotRequired[ParallelGroup]

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

parameters instance-attribute

parameters: NotRequired[WorkflowParameterList]

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

workflow_arn instance-attribute

The Amazon Resource Name (ARN) of the workflow resource.