2025/11/17 - AmazonMWAAServerless - 15 new api methods
Changes Amazon MWAA now offers serverless deployment, eliminating operational overhead while optimizing costs. The service supports YAML and Python-based workflows, with 80+ AWS Operators. It provides isolated execution, IAM permissions, and automatic scaling with pay-per-use pricing.
Retrieves detailed information about a workflow, including its configuration, status, and metadata.
See also: AWS API Documentation
Request Syntax
client.get_workflow(
WorkflowArn='string',
WorkflowVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow you want to retrieve.
string
Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.
dict
Response Syntax
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'Name': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'EncryptionConfiguration': {
'Type': 'AWS_MANAGED_KEY'|'CUSTOMER_MANAGED_KEY',
'KmsKeyId': 'string'
},
'LoggingConfiguration': {
'LogGroupName': 'string'
},
'EngineVersion': 123,
'WorkflowStatus': 'READY'|'DELETING',
'DefinitionS3Location': {
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
'ScheduleConfiguration': {
'CronExpression': 'string'
},
'RoleArn': 'string',
'NetworkConfiguration': {
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
]
},
'TriggerMode': 'string',
'WorkflowDefinition': 'string'
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow.
WorkflowVersion (string) --
The version identifier of the workflow.
Name (string) --
The name of the workflow.
Description (string) --
The description of the workflow.
CreatedAt (datetime) --
The timestamp when the workflow was created, in ISO 8601 date-time format.
ModifiedAt (datetime) --
The timestamp when the workflow was last modified, in ISO 8601 date-time format.
EncryptionConfiguration (dict) --
The encryption configuration for the workflow.
Type (string) --
The type of encryption to use. Values are AWS_MANAGED_KEY (Amazon Web Services manages the encryption key) or CUSTOMER_MANAGED_KEY (you provide a KMS key).
KmsKeyId (string) --
The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when Type is CUSTOMER_MANAGED_KEY.
LoggingConfiguration (dict) --
The logging configuration for the workflow.
LogGroupName (string) --
The name of the CloudWatch log group where workflow execution logs are stored.
EngineVersion (integer) --
The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.
WorkflowStatus (string) --
The current status of the workflow.
DefinitionS3Location (dict) --
The Amazon S3 location of the workflow definition file.
Bucket (string) --
The name of the Amazon S3 bucket that contains the workflow definition file.
ObjectKey (string) --
The key (name) of the workflow definition file within the S3 bucket.
VersionId (string) --
Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
ScheduleConfiguration (dict) --
The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time.
CronExpression (string) --
A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for workflow execution.
NetworkConfiguration (dict) --
The network configuration for the workflow execution environment.
SecurityGroupIds (list) --
A list of VPC security group IDs to associate with the workflow execution environment.
(string) --
SubnetIds (list) --
A list of VPC subnet IDs where the workflow execution environment is deployed.
(string) --
TriggerMode (string) --
The trigger mode for the workflow execution.
WorkflowDefinition (string) --
The workflow definition content.
Lists all workflows in your account, with optional pagination support. This operation returns summary information for workflows, showing only the most recently created version of each workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains workflow metadata in a highly available, distributed storage system that enables efficient querying and filtering. The service implements proper access controls to ensure you can only view workflows that you have permissions to access, supporting both individual and team-based workflow management scenarios.
See also: AWS API Documentation
Request Syntax
client.list_workflows(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of workflows you want to return in a single response.
string
The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListWorkflows.
dict
Response Syntax
{
'Workflows': [
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'Name': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'WorkflowStatus': 'READY'|'DELETING',
'TriggerMode': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Workflows (list) --
A list of workflow summaries for all workflows in your account.
(dict) --
Summary information about a workflow, including basic identification and metadata.
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow.
WorkflowVersion (string) --
The version identifier of the workflow.
Name (string) --
The name of the workflow.
Description (string) --
The description of the workflow.
CreatedAt (datetime) --
The timestamp when the workflow was created, in ISO 8601 date-time format.
ModifiedAt (datetime) --
The timestamp when the workflow was last modified, in ISO 8601 date-time format.
WorkflowStatus (string) --
The current status of the workflow.
TriggerMode (string) --
The trigger mode for the workflow execution.
NextToken (string) --
The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.
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
client.start_workflow_run(
WorkflowArn='string',
ClientToken='string',
OverrideParameters={
'string': {...}|[...]|123|123.4|'string'|True|None
},
WorkflowVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow you want to run.
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.
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) --
(:ref:`document<document>`) --
string
Optional. The specific version of the workflow to execute. If not specified, the latest version is used.
dict
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 STARTING when you first create the run.
StartedAt (datetime) --
The timestamp when the workflow run was started, in ISO 8601 date-time format.
Lists all versions of a specified workflow, with optional pagination support.
See also: AWS API Documentation
Request Syntax
client.list_workflow_versions(
MaxResults=123,
NextToken='string',
WorkflowArn='string'
)
integer
The maximum number of workflow versions to return in a single response.
string
The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListWorkflowVersions.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow for which you want to list versions.
dict
Response Syntax
{
'WorkflowVersions': [
{
'WorkflowVersion': 'string',
'WorkflowArn': 'string',
'IsLatestVersion': True|False,
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'DefinitionS3Location': {
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
'ScheduleConfiguration': {
'CronExpression': 'string'
},
'TriggerMode': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkflowVersions (list) --
A list of workflow version summaries for the specified workflow.
(dict) --
Summary information about a workflow version, including identification and configuration details.
WorkflowVersion (string) --
The version identifier of the workflow version.
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this version.
IsLatestVersion (boolean) --
Boolean flag that indicates whether this is the latest version of the workflow.
CreatedAt (datetime) --
The timestamp when the workflow version was created, in ISO 8601 date-time format.
ModifiedAt (datetime) --
The timestamp when the workflow version was last modified, in ISO 8601 date-time format.
DefinitionS3Location (dict) --
The Amazon S3 location of the workflow definition file for this version.
Bucket (string) --
The name of the Amazon S3 bucket that contains the workflow definition file.
ObjectKey (string) --
The key (name) of the workflow definition file within the S3 bucket.
VersionId (string) --
Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
ScheduleConfiguration (dict) --
The schedule configuration for this workflow version.
CronExpression (string) --
A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.
TriggerMode (string) --
The trigger mode for the workflow execution.
NextToken (string) --
The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.
Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.
See also: AWS API Documentation
Request Syntax
client.get_workflow_run(
WorkflowArn='string',
RunId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow that contains the run.
string
[REQUIRED]
The unique identifier of the workflow run to retrieve.
dict
Response Syntax
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'RunId': 'string',
'RunType': 'ON_DEMAND'|'SCHEDULED',
'OverrideParameters': {
'string': {...}|[...]|123|123.4|'string'|True|None
},
'RunDetail': {
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'RunId': 'string',
'RunType': 'ON_DEMAND'|'SCHEDULED',
'StartedOn': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Duration': 123,
'ErrorMessage': 'string',
'TaskInstances': [
'string',
],
'RunState': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED'
}
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this run.
WorkflowVersion (string) --
The version of the workflow that is used for this run.
RunId (string) --
The unique identifier of this workflow run.
RunType (string) --
The type of workflow run. Values are ON_DEMAND (manually triggered) or SCHEDULED (automatically triggered by schedule).
OverrideParameters (dict) --
Parameters that were overridden for this specific workflow run.
(string) --
(:ref:`document<document>`) --
RunDetail (dict) --
Detailed information about the workflow run execution, including timing, status, and task instances.
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this run.
WorkflowVersion (string) --
The version of the workflow used for this run.
RunId (string) --
The unique identifier of this workflow run.
RunType (string) --
The type of workflow run.
StartedOn (datetime) --
The timestamp when the workflow run started execution, in ISO 8601 date-time format.
CreatedAt (datetime) --
The timestamp when the workflow run was created, in ISO 8601 date-time format.
CompletedOn (datetime) --
The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.
ModifiedAt (datetime) --
The timestamp when the workflow run was last modified, in ISO 8601 date-time format.
Duration (integer) --
The total duration of the workflow run execution in seconds. This value is null if the run is not complete.
ErrorMessage (string) --
The error message if the workflow run failed. This value is null if the run completed successfully.
TaskInstances (list) --
A list of task instance IDs that are part of this workflow run.
(string) --
RunState (string) --
The current execution state of the workflow run.
Creates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless. This operation initializes a workflow with the specified configuration including the workflow definition, execution role, and optional settings for encryption, logging, and networking. You must provide the workflow definition as a YAML file stored in Amazon S3 that defines the DAG structure using supported Amazon Web Services operators. Amazon Managed Workflows for Apache Airflow Serverless automatically creates the first version of the workflow and sets up the necessary execution environment with multi-tenant isolation and security controls.
See also: AWS API Documentation
Request Syntax
client.create_workflow(
Name='string',
ClientToken='string',
DefinitionS3Location={
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
RoleArn='string',
Description='string',
EncryptionConfiguration={
'Type': 'AWS_MANAGED_KEY'|'CUSTOMER_MANAGED_KEY',
'KmsKeyId': 'string'
},
LoggingConfiguration={
'LogGroupName': 'string'
},
EngineVersion=123,
NetworkConfiguration={
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
]
},
Tags={
'string': 'string'
},
TriggerMode='string'
)
string
[REQUIRED]
The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.
This field is autopopulated if not provided.
dict
[REQUIRED]
The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.
Bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket that contains the workflow definition file.
ObjectKey (string) -- [REQUIRED]
The key (name) of the workflow definition file within the S3 bucket.
VersionId (string) --
Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.
string
An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.
dict
The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.
Type (string) -- [REQUIRED]
The type of encryption to use. Values are AWS_MANAGED_KEY (Amazon Web Services manages the encryption key) or CUSTOMER_MANAGED_KEY (you provide a KMS key).
KmsKeyId (string) --
The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when Type is CUSTOMER_MANAGED_KEY.
dict
The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.
LogGroupName (string) -- [REQUIRED]
The name of the CloudWatch log group where workflow execution logs are stored.
integer
The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.
dict
Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service's default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.
SecurityGroupIds (list) --
A list of VPC security group IDs to associate with the workflow execution environment.
(string) --
SubnetIds (list) --
A list of VPC subnet IDs where the workflow execution environment is deployed.
(string) --
dict
A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.
(string) --
(string) --
string
The trigger mode for the workflow execution.
dict
Response Syntax
{
'WorkflowArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'RevisionId': 'string',
'WorkflowStatus': 'READY'|'DELETING',
'WorkflowVersion': 'string',
'IsLatestVersion': True|False,
'Warnings': [
'string',
]
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the newly created workflow. This ARN uniquely identifies the workflow resource.
CreatedAt (datetime) --
The timestamp when the workflow was created, in ISO 8601 date-time format.
RevisionId (string) --
A unique identifier for this revision of the workflow configuration. This ID changes when the workflow is updated and you can use it for optimistic concurrency control in update operations. The revision ID helps prevent conflicting updates and ensures that updates are applied to the expected version of the workflow configuration.
WorkflowStatus (string) --
The current status of the workflow. Possible values are READY (workflow is ready to run) and DELETING (workflow is being deleted).
WorkflowVersion (string) --
The version identifier of the workflow. This is a service-generated alphanumeric string that uniquely identifies this version of the workflow. Amazon Managed Workflows for Apache Airflow Serverless uses a version-first approach where each workflow can have multiple immutable versions, which allows you to maintain different configurations and roll back to previous versions as needed. The version identifier is used in ARNs and API operations to reference specific workflow versions.
IsLatestVersion (boolean) --
A Boolean flag that indicates whether this workflow version is the latest version of the workflow.
Warnings (list) --
Warning messages generated during workflow creation.
(string) --
Lists all tags that are associated with a specified Amazon Managed Workflows for Apache Airflow Serverless resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which to list tags.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
A map of tags that are associated with the resource, where each tag consists of a key-value pair.
(string) --
(string) --
Lists all task instances for a specific workflow run, with optional pagination support.
See also: AWS API Documentation
Request Syntax
client.list_task_instances(
WorkflowArn='string',
RunId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow that contains the run.
string
[REQUIRED]
The unique identifier of the workflow run for which you want a list of task instances.
integer
The maximum number of task instances to return in a single response.
string
The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListTaskInstances.
dict
Response Syntax
{
'TaskInstances': [
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'RunId': 'string',
'TaskInstanceId': 'string',
'Status': 'QUEUED'|'FAILED'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'UP_FOR_RESCHEDULE'|'UP_FOR_RETRY'|'UPSTREAM_FAILED'|'REMOVED'|'RESTARTING'|'DEFERRED'|'NONE'|'CANCELLED'|'TIMEOUT',
'DurationInSeconds': 123,
'OperatorName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskInstances (list) --
A list of task instance summaries for the specified workflow run.
(dict) --
Summary information about a task instance within a workflow run, including its status and execution details.
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this task instance.
WorkflowVersion (string) --
The version of the workflow that contains this task instance.
RunId (string) --
The unique identifier of the workflow run that contains this task instance.
TaskInstanceId (string) --
The unique identifier of this task instance.
Status (string) --
The current status of the task instance.
DurationInSeconds (integer) --
The duration of the task instance execution in seconds. This value is null if the task is not complete.
OperatorName (string) --
The name of the Apache Airflow operator used for this task instance.
NextToken (string) --
The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.
Removes tags from an Amazon Managed Workflows for Apache Airflow Serverless resource. This operation removes the specified tags from the resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to remove tags.
list
[REQUIRED]
A list of tag keys to remove from the resource. Only the keys are required; the values are ignored.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves detailed information about a specific task instance within a workflow run. Task instances represent individual tasks that are executed as part of a workflow in the Amazon Managed Workflows for Apache Airflow Serverless environment. Each task instance runs in an isolated ECS container with dedicated resources and security boundaries. The service tracks task execution state, retry attempts, and provides detailed timing and error information for troubleshooting and monitoring purposes.
See also: AWS API Documentation
Request Syntax
client.get_task_instance(
WorkflowArn='string',
TaskInstanceId='string',
RunId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow that contains the task instance.
string
[REQUIRED]
The unique identifier of the task instance to retrieve.
string
[REQUIRED]
The unique identifier of the workflow run that contains the task instance.
dict
Response Syntax
{
'WorkflowArn': 'string',
'RunId': 'string',
'TaskInstanceId': 'string',
'WorkflowVersion': 'string',
'Status': 'QUEUED'|'FAILED'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'UP_FOR_RESCHEDULE'|'UP_FOR_RETRY'|'UPSTREAM_FAILED'|'REMOVED'|'RESTARTING'|'DEFERRED'|'NONE'|'CANCELLED'|'TIMEOUT',
'DurationInSeconds': 123,
'OperatorName': 'string',
'ModifiedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'StartedAt': datetime(2015, 1, 1),
'AttemptNumber': 123,
'ErrorMessage': 'string',
'TaskId': 'string',
'LogStream': 'string',
'Xcom': {
'string': 'string'
}
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this task instance.
RunId (string) --
The unique identifier of the workflow run that contains this task instance.
TaskInstanceId (string) --
The unique identifier of this task instance.
WorkflowVersion (string) --
The version of the workflow that contains this task instance.
Status (string) --
The current status of the task instance.
DurationInSeconds (integer) --
The duration of the task instance execution in seconds. This value is null if the task is not complete.
OperatorName (string) --
The name of the Apache Airflow operator used for this task instance.
ModifiedAt (datetime) --
The timestamp when the task instance was last modified, in ISO 8601 date-time format.
EndedAt (datetime) --
The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.
StartedAt (datetime) --
The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.
AttemptNumber (integer) --
The attempt number for this task instance.
ErrorMessage (string) --
The error message if the task instance failed. This value is null if the task completed successfully.
TaskId (string) --
The unique identifier of the task definition within the workflow.
LogStream (string) --
The CloudWatch log stream name for this task instance execution.
Xcom (dict) --
Cross-communication data exchanged between tasks in the workflow execution.
(string) --
(string) --
Lists all runs for a specified workflow, with optional pagination and filtering support.
See also: AWS API Documentation
Request Syntax
client.list_workflow_runs(
MaxResults=123,
NextToken='string',
WorkflowArn='string',
WorkflowVersion='string'
)
integer
The maximum number of workflow runs to return in a single response.
string
The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListWorkflowRuns.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.
string
Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.
dict
Response Syntax
{
'WorkflowRuns': [
{
'RunId': 'string',
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'RunType': 'ON_DEMAND'|'SCHEDULED',
'RunDetailSummary': {
'Status': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
'CreatedOn': datetime(2015, 1, 1),
'StartedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkflowRuns (list) --
A list of workflow run summaries for the specified workflow.
(dict) --
Summary information about a workflow run, including basic identification and status information.
RunId (string) --
The unique identifier of the workflow run.
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains this run.
WorkflowVersion (string) --
The version of the workflow used for this run.
RunType (string) --
The type of workflow run.
RunDetailSummary (dict) --
Summary details about the workflow run execution.
Status (string) --
The current status of the workflow run.
CreatedOn (datetime) --
The timestamp when the workflow run was created, in ISO 8601 date-time format.
StartedAt (datetime) --
The timestamp when the workflow run started execution, in ISO 8601 date-time format.
EndedAt (datetime) --
The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.
NextToken (string) --
The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.
Adds tags to an Amazon Managed Workflows for Apache Airflow Serverless resource. Tags are key-value pairs that help you organize and categorize your resources.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which to add tags.
dict
[REQUIRED]
A map of tags to add to the resource. Each tag consists of a key-value pair.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Stops a running workflow execution. This operation terminates all running tasks and prevents new tasks from starting. Amazon Managed Workflows for Apache Airflow Serverless gracefully shuts down the workflow execution by stopping task scheduling and terminating active ECS worker containers. The operation transitions the workflow run to a STOPPING state and then to STOPPED once all cleanup is complete. In-flight tasks may complete or be terminated depending on their current execution state.
See also: AWS API Documentation
Request Syntax
client.stop_workflow_run(
WorkflowArn='string',
RunId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.
string
[REQUIRED]
The unique identifier of the workflow run to stop.
dict
Response Syntax
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string',
'RunId': 'string',
'Status': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED'
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the workflow that contains the stopped run.
WorkflowVersion (string) --
The version of the workflow that was stopped.
RunId (string) --
The unique identifier of the stopped workflow run.
Status (string) --
The status of the workflow run after the stop operation. This is typically STOPPING or STOPPED.
Deletes a workflow and all its versions. This operation permanently removes the workflow and cannot be undone. Amazon Managed Workflows for Apache Airflow Serverless ensures that all associated resources are properly cleaned up, including stopping any running executions, removing scheduled triggers, and cleaning up execution history. The deletion process respects the multi-tenant isolation boundaries and ensures that no residual data or configurations remain that could affect other customers or workflows.
See also: AWS API Documentation
Request Syntax
client.delete_workflow(
WorkflowArn='string',
WorkflowVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow you want to delete.
string
Optional. The specific version of the workflow to delete. If not specified, all versions of the workflow are deleted.
dict
Response Syntax
{
'WorkflowArn': 'string',
'WorkflowVersion': 'string'
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the deleted workflow.
WorkflowVersion (string) --
The version of the workflow that was deleted.
Updates an existing workflow with new configuration settings. This operation allows you to modify the workflow definition, role, and other settings. When you update a workflow, Amazon Managed Workflows for Apache Airflow Serverless automatically creates a new version with the updated configuration and disables scheduling on all previous versions to ensure only one version is actively scheduled at a time. The update operation maintains workflow history while providing a clean transition to the new configuration.
See also: AWS API Documentation
Request Syntax
client.update_workflow(
WorkflowArn='string',
DefinitionS3Location={
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
RoleArn='string',
Description='string',
LoggingConfiguration={
'LogGroupName': 'string'
},
EngineVersion=123,
NetworkConfiguration={
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
]
},
TriggerMode='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow you want to update.
dict
[REQUIRED]
The Amazon S3 location where the updated workflow definition file is stored.
Bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket that contains the workflow definition file.
ObjectKey (string) -- [REQUIRED]
The key (name) of the workflow definition file within the S3 bucket.
VersionId (string) --
Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when it executes the updated workflow.
string
An updated description for the workflow.
dict
Updated logging configuration for the workflow.
LogGroupName (string) -- [REQUIRED]
The name of the CloudWatch log group where workflow execution logs are stored.
integer
The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for the updated workflow.
dict
Updated network configuration for the workflow execution environment.
SecurityGroupIds (list) --
A list of VPC security group IDs to associate with the workflow execution environment.
(string) --
SubnetIds (list) --
A list of VPC subnet IDs where the workflow execution environment is deployed.
(string) --
string
The trigger mode for the workflow execution.
dict
Response Syntax
{
'WorkflowArn': 'string',
'ModifiedAt': datetime(2015, 1, 1),
'WorkflowVersion': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
WorkflowArn (string) --
The Amazon Resource Name (ARN) of the updated workflow.
ModifiedAt (datetime) --
The timestamp when the workflow was last modified, in ISO 8601 date-time format.
WorkflowVersion (string) --
The version identifier of the updated workflow.
Warnings (list) --
Warning messages generated during workflow update.
(string) --