Workflow ¶

class Workflow(TypedDict, closed=True):
    arn: NotRequired[
        "capo_imagebuilder.types.workflow_build_version_arn.WorkflowBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the workflow resource.</p>"""
    name: NotRequired["capo_imagebuilder.types.resource_name.ResourceName"]
    """<p>The name of the workflow resource.</p>"""
    version: NotRequired["capo_imagebuilder.types.version_number.VersionNumber"]
    """<p>The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.</p>"""
    description: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The description of the workflow.</p>"""
    change_description: NotRequired[
        "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    ]
    """<p>Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.</p>"""
    type: NotRequired["capo_imagebuilder.types.workflow_type.WorkflowType"]
    """<p>The image creation stage that the workflow applies to.</p>"""
    state: NotRequired["capo_imagebuilder.types.workflow_state.WorkflowState"]
    """<p>Describes the current status of the workflow and the reason for that status.</p>"""
    owner: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The owner of the workflow resource.</p>"""
    data: NotRequired["capo_imagebuilder.types.workflow_data.WorkflowData"]
    """<p>Contains the YAML document content for the workflow.</p>"""
    kms_key_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a> in the <i>Key Management Service Developer Guide</i>.</p>"""
    date_created: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when Image Builder created the workflow resource.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags that apply to the workflow resource.</p>"""
    parameters: NotRequired[
        "capo_imagebuilder.types.workflow_parameter_detail_list.WorkflowParameterDetailList"
    ]
    """<p>An array of input parameters that the image workflow uses to control actions or configure settings.</p>"""