Skip to content

CreateWorkflowRequest

Source code in docs_src/capo_glue/types/create_workflow_request.py
class CreateWorkflowRequest(TypedDict, closed=True):
    name: "capo_glue.types.name_string.NameString"
    """<p>The name to be assigned to the workflow. It should be unique within your account.</p>"""
    description: NotRequired[
        "capo_glue.types.workflow_description_string.WorkflowDescriptionString"
    ]
    """<p>A description of the workflow.</p>"""
    default_run_properties: NotRequired[
        "capo_glue.types.workflow_run_properties.WorkflowRunProperties"
    ]
    """<p>A collection of properties to be used as part of each execution of the workflow.</p> <p>Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.</p>"""
    tags: NotRequired["capo_glue.types.tags_map.TagsMap"]
    """<p>The tags to be used with this workflow.</p>"""
    max_concurrent_runs: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.</p>"""

default_run_properties instance-attribute

default_run_properties: NotRequired[WorkflowRunProperties]

A collection of properties to be used as part of each execution of the workflow.

Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.

description instance-attribute

description: NotRequired[WorkflowDescriptionString]

A description of the workflow.

max_concurrent_runs instance-attribute

max_concurrent_runs: NotRequired[NullableInteger]

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

name instance-attribute

name: NameString

The name to be assigned to the workflow. It should be unique within your account.

tags instance-attribute

tags: NotRequired[TagsMap]

The tags to be used with this workflow.