MWAAServerless / Client / start_workflow_run
start_workflow_run¶
- MWAAServerless.Client.start_workflow_run(**kwargs)¶
Starts a new execution of a workflow. This operation creates a workflow run that executes the tasks that are defined in the workflow. Amazon Managed Workflows for Apache Airflow Serverless schedules the workflow execution across its managed Airflow environment, automatically scaling ECS worker tasks based on the workload. The service handles task isolation, dependency resolution, and provides comprehensive monitoring and logging throughout the execution lifecycle.
See also: AWS API Documentation
Request Syntax
response = client.start_workflow_run( WorkflowArn='string', ClientToken='string', OverrideParameters={ 'string': {...}|[...]|123|123.4|'string'|True|None }, WorkflowVersion='string' )
- Parameters:
WorkflowArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow you want to run.
ClientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.
This field is autopopulated if not provided.
OverrideParameters (dict) –
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.
(string) –
(document) –
WorkflowVersion (string) – Optional. The specific version of the workflow to execute. If not specified, the latest version is used.
- Return type:
dict
- Returns:
Response Syntax
{ 'RunId': 'string', 'Status': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED', 'StartedAt': datetime(2015, 1, 1) }
Response Structure
(dict) –
RunId (string) –
The unique identifier of the newly started workflow run.
Status (string) –
The initial status of the workflow run. This is typically
STARTINGwhen you first create the run.StartedAt (datetime) –
The timestamp when the workflow run was started, in ISO 8601 date-time format.
Exceptions
MWAAServerless.Client.exceptions.ThrottlingExceptionMWAAServerless.Client.exceptions.ValidationExceptionMWAAServerless.Client.exceptions.ResourceNotFoundExceptionMWAAServerless.Client.exceptions.AccessDeniedExceptionMWAAServerless.Client.exceptions.InternalServerExceptionMWAAServerless.Client.exceptions.OperationTimeoutExceptionMWAAServerless.Client.exceptions.ConflictExceptionMWAAServerless.Client.exceptions.ServiceQuotaExceededException