Skip to content

StartWorkflowRunRequest

Source code in docs_src/capo_mwaa_serverless/types/start_workflow_run_request.py
class StartWorkflowRunRequest(TypedDict, closed=True):
    workflow_arn: "capo_mwaa_serverless.types.workflow_arn.WorkflowArn"
    """<p>The Amazon Resource Name (ARN) of the workflow you want to run.</p>"""
    client_token: NotRequired[
        "capo_mwaa_serverless.types.idempotency_token_string.IdempotencyTokenString"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.</p>"""
    override_parameters: NotRequired["capo_mwaa_serverless.types.object_map.ObjectMap"]
    """<p>Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.</p>"""
    workflow_version: NotRequired["capo_mwaa_serverless.types.version_id.VersionId"]
    """<p>Optional. The specific version of the workflow to execute. If not specified, the latest version is used.</p>"""

client_token instance-attribute

client_token: NotRequired[IdempotencyTokenString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.

override_parameters instance-attribute

override_parameters: NotRequired[ObjectMap]

Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.

workflow_arn instance-attribute

workflow_arn: WorkflowArn

The Amazon Resource Name (ARN) of the workflow you want to run.

workflow_version instance-attribute

workflow_version: NotRequired[VersionId]

Optional. The specific version of the workflow to execute. If not specified, the latest version is used.