Api-Mwaa-Serverless-2024-07-26 - AWS SDK for PHP V3

Client: Aws\MWAAServerless\MWAAServerlessClient

Service ID: mwaa-serverless

Version: 2024-07-26

This page describes the parameters and results for the operations of the AmazonMWAAServerless (2024-07-26), and shows how to use the Aws\MWAAServerless\MWAAServerlessClient object to call the described operations. This documentation is specific to the 2024-07-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateWorkflow ( array $params = [] ): Creates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless.
DeleteWorkflow ( array $params = [] ): Deletes a workflow and all its versions.
GetTaskInstance ( array $params = [] ): Retrieves detailed information about a specific task instance within a workflow run.
GetWorkflow ( array $params = [] ): Retrieves detailed information about a workflow, including its configuration, status, and metadata.
GetWorkflowRun ( array $params = [] ): Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.
ListTagsForResource ( array $params = [] ): Lists all tags that are associated with a specified Amazon Managed Workflows for Apache Airflow Serverless resource.
ListTaskInstances ( array $params = [] ): Lists all task instances for a specific workflow run, with optional pagination support.
ListWorkflowRuns ( array $params = [] ): Lists all runs for a specified workflow, with optional pagination and filtering support.
ListWorkflowVersions ( array $params = [] ): Lists all versions of a specified workflow, with optional pagination support.
ListWorkflows ( array $params = [] ): Lists all workflows in your account, with optional pagination support.
StartWorkflowRun ( array $params = [] ): Starts a new execution of a workflow.
StopWorkflowRun ( array $params = [] ): Stops a running workflow execution.
TagResource ( array $params = [] ): Adds tags to an Amazon Managed Workflows for Apache Airflow Serverless resource.
UntagResource ( array $params = [] ): Removes tags from an Amazon Managed Workflows for Apache Airflow Serverless resource.
UpdateWorkflow ( array $params = [] ): Updates an existing workflow with new configuration settings.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListTaskInstances
ListWorkflowRuns
ListWorkflowVersions
ListWorkflows

Operations

CreateWorkflow

$result = $client->createWorkflow([/* ... */]);
$promise = $client->createWorkflowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createWorkflow([
    'ClientToken' => '<string>',
    'DefinitionS3Location' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'ObjectKey' => '<string>', // REQUIRED
        'VersionId' => '<string>',
    ],
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
        'Type' => 'AWS_MANAGED_KEY|CUSTOMER_MANAGED_KEY', // REQUIRED
    ],
    'EngineVersion' => <integer>,
    'LoggingConfiguration' => [
        'LogGroupName' => '<string>', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'NetworkConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'TriggerMode' => '<string>',
]);

Parameter Details

Members

ClientToken

: Type: string

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

DefinitionS3Location

: Required: Yes
: Type: DefinitionS3Location structure

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.

Description

: Type: string

An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.

EngineVersion

: Type: int

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.

LoggingConfiguration

: Type: LoggingConfiguration structure

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.

Name

: Required: Yes
: Type: string

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.

NetworkConfiguration

: Type: NetworkConfiguration structure

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.

RoleArn

: Required: Yes
: Type: string

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.

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.

TriggerMode

: Type: string

The trigger mode for the workflow execution.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'IsLatestVersion' => true || false,
    'RevisionId' => '<string>',
    'Warnings' => ['<string>', ...],
    'WorkflowArn' => '<string>',
    'WorkflowStatus' => 'READY|DELETING',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was created, in ISO 8601 date-time format.

IsLatestVersion

: Type: boolean

A Boolean flag that indicates whether this workflow version is the latest version of the workflow.

RevisionId

: Type: 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.

Warnings

: Type: Array of strings

Warning messages generated during workflow creation.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the newly created workflow. This ARN uniquely identifies the workflow resource.

WorkflowStatus

: Type: string

The current status of the workflow. Possible values are READY (workflow is ready to run) and DELETING (workflow is being deleted).

WorkflowVersion

: Type: 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.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.
ConflictException:: You cannot create a resource that already exists, or the resource is in a state that prevents the requested operation.
ServiceQuotaExceededException:: The request exceeds the service quota for Amazon Managed Workflows for Apache Airflow Serverless resources. This can occur when you attempt to create more workflows than allowed, exceed concurrent workflow run limits, or surpass task execution limits. Amazon Managed Workflows for Apache Airflow Serverless implements admission control using DynamoDB-based counters to manage resource utilization across the multi-tenant environment. Contact Amazon Web Services Support to request quota increases if you need higher limits for your use case.

DeleteWorkflow

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteWorkflow([
    'WorkflowArn' => '<string>', // REQUIRED
    'WorkflowVersion' => '<string>',
]);

Parameter Details

Members

WorkflowArn

: Required: Yes
: Type: string

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

WorkflowVersion

: Type: string

Optional. The specific version of the workflow to delete. If not specified, all versions of the workflow are deleted.

Result Syntax

[
    'WorkflowArn' => '<string>',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the deleted workflow.

WorkflowVersion

: Type: string

The version of the workflow that was deleted.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

GetTaskInstance

$result = $client->getTaskInstance([/* ... */]);
$promise = $client->getTaskInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTaskInstance([
    'RunId' => '<string>', // REQUIRED
    'TaskInstanceId' => '<string>', // REQUIRED
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

RunId

: Required: Yes
: Type: string

The unique identifier of the workflow run that contains the task instance.

TaskInstanceId

: Required: Yes
: Type: string

The unique identifier of the task instance to retrieve.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow that contains the task instance.

Result Syntax

[
    'AttemptNumber' => <integer>,
    'DurationInSeconds' => <integer>,
    'EndedAt' => <DateTime>,
    'ErrorMessage' => '<string>',
    'LogStream' => '<string>',
    'ModifiedAt' => <DateTime>,
    'OperatorName' => '<string>',
    'RunId' => '<string>',
    'StartedAt' => <DateTime>,
    'Status' => 'QUEUED|FAILED|SCHEDULED|RUNNING|SUCCESS|UP_FOR_RESCHEDULE|UP_FOR_RETRY|UPSTREAM_FAILED|REMOVED|RESTARTING|DEFERRED|NONE|CANCELLED|TIMEOUT',
    'TaskId' => '<string>',
    'TaskInstanceId' => '<string>',
    'WorkflowArn' => '<string>',
    'WorkflowVersion' => '<string>',
    'Xcom' => ['<string>', ...],
]

Result Details

Members

AttemptNumber

: Type: int

The attempt number for this task instance.

DurationInSeconds

: Type: int

The duration of the task instance execution in seconds. This value is null if the task is not complete.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.

ErrorMessage

: Type: string

The error message if the task instance failed. This value is null if the task completed successfully.

LogStream

: Type: string

The CloudWatch log stream name for this task instance execution.

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the task instance was last modified, in ISO 8601 date-time format.

OperatorName

: Type: string

The name of the Apache Airflow operator used for this task instance.

RunId

: Required: Yes
: Type: string

The unique identifier of the workflow run that contains this task instance.

StartedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.

Status

: Type: string

The current status of the task instance.

TaskId

: Type: string

The unique identifier of the task definition within the workflow.

TaskInstanceId

: Required: Yes
: Type: string

The unique identifier of this task instance.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this task instance.

WorkflowVersion

: Type: string

The version of the workflow that contains this task instance.

Xcom

: Type: Associative array of custom strings keys (GenericString) to strings

Cross-communication data exchanged between tasks in the workflow execution.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

GetWorkflow

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Retrieves detailed information about a workflow, including its configuration, status, and metadata.

Parameter Syntax

$result = $client->getWorkflow([
    'WorkflowArn' => '<string>', // REQUIRED
    'WorkflowVersion' => '<string>',
]);

Parameter Details

Members

WorkflowArn

: Required: Yes
: Type: string

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

WorkflowVersion

: Type: string

Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DefinitionS3Location' => [
        'Bucket' => '<string>',
        'ObjectKey' => '<string>',
        'VersionId' => '<string>',
    ],
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
        'Type' => 'AWS_MANAGED_KEY|CUSTOMER_MANAGED_KEY',
    ],
    'EngineVersion' => <integer>,
    'LoggingConfiguration' => [
        'LogGroupName' => '<string>',
    ],
    'ModifiedAt' => <DateTime>,
    'Name' => '<string>',
    'NetworkConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
    'RoleArn' => '<string>',
    'ScheduleConfiguration' => [
        'CronExpression' => '<string>',
    ],
    'TriggerMode' => '<string>',
    'WorkflowArn' => '<string>',
    'WorkflowDefinition' => '<string>',
    'WorkflowStatus' => 'READY|DELETING',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was created, in ISO 8601 date-time format.

DefinitionS3Location

: Type: DefinitionS3Location structure

The Amazon S3 location of the workflow definition file.

Description

: Type: string

The description of the workflow.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

The encryption configuration for the workflow.

EngineVersion

: Type: int

The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.

LoggingConfiguration

: Type: LoggingConfiguration structure

The logging configuration for the workflow.

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was last modified, in ISO 8601 date-time format.

Name

: Type: string

The name of the workflow.

NetworkConfiguration

: Type: NetworkConfiguration structure

The network configuration for the workflow execution environment.

RoleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role used for workflow execution.

ScheduleConfiguration

: Type: ScheduleConfiguration structure

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.

TriggerMode

: Type: string

The trigger mode for the workflow execution.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow.

WorkflowDefinition

: Type: string

The workflow definition content.

WorkflowStatus

: Type: string

The current status of the workflow.

WorkflowVersion

: Type: string

The version identifier of the workflow.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

GetWorkflowRun

$result = $client->getWorkflowRun([/* ... */]);
$promise = $client->getWorkflowRunAsync([/* ... */]);

Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.

Parameter Syntax

$result = $client->getWorkflowRun([
    'RunId' => '<string>', // REQUIRED
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

RunId

: Required: Yes
: Type: string

The unique identifier of the workflow run to retrieve.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow that contains the run.

Result Syntax

[
    'OverrideParameters' => [
        '<String>' => [
        ],
        // ...
    ],
    'RunDetail' => [
        'CompletedOn' => <DateTime>,
        'CreatedAt' => <DateTime>,
        'Duration' => <integer>,
        'ErrorMessage' => '<string>',
        'ModifiedAt' => <DateTime>,
        'RunId' => '<string>',
        'RunState' => 'STARTING|QUEUED|RUNNING|SUCCESS|FAILED|TIMEOUT|STOPPING|STOPPED',
        'RunType' => 'ON_DEMAND|SCHEDULED',
        'StartedOn' => <DateTime>,
        'TaskInstances' => ['<string>', ...],
        'WorkflowArn' => '<string>',
        'WorkflowVersion' => '<string>',
    ],
    'RunId' => '<string>',
    'RunType' => 'ON_DEMAND|SCHEDULED',
    'WorkflowArn' => '<string>',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

OverrideParameters

: Type: Associative array of custom strings keys (String) to document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documentss

Parameters that were overridden for this specific workflow run.

RunDetail

: Type: WorkflowRunDetail structure

Detailed information about the workflow run execution, including timing, status, and task instances.

RunId

: Type: string

The unique identifier of this workflow run.

RunType

: Type: string

The type of workflow run. Values are ON_DEMAND (manually triggered) or SCHEDULED (automatically triggered by schedule).

WorkflowArn

: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this run.

WorkflowVersion

: Type: string

The version of the workflow that is used for this run.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags that are associated with a specified Amazon Managed Workflows for Apache Airflow Serverless resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which to list tags.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

A map of tags that are associated with the resource, where each tag consists of a key-value pair.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

ListTaskInstances

$result = $client->listTaskInstances([/* ... */]);
$promise = $client->listTaskInstancesAsync([/* ... */]);

Lists all task instances for a specific workflow run, with optional pagination support.

Parameter Syntax

$result = $client->listTaskInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RunId' => '<string>', // REQUIRED
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of task instances to return in a single response.

NextToken

: Type: 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.

RunId

: Required: Yes
: Type: string

The unique identifier of the workflow run for which you want a list of task instances.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow that contains the run.

Result Syntax

[
    'NextToken' => '<string>',
    'TaskInstances' => [
        [
            'DurationInSeconds' => <integer>,
            'OperatorName' => '<string>',
            'RunId' => '<string>',
            'Status' => 'QUEUED|FAILED|SCHEDULED|RUNNING|SUCCESS|UP_FOR_RESCHEDULE|UP_FOR_RETRY|UPSTREAM_FAILED|REMOVED|RESTARTING|DEFERRED|NONE|CANCELLED|TIMEOUT',
            'TaskInstanceId' => '<string>',
            'WorkflowArn' => '<string>',
            'WorkflowVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

TaskInstances

: Type: Array of TaskInstanceSummary structures

A list of task instance summaries for the specified workflow run.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

ListWorkflowRuns

$result = $client->listWorkflowRuns([/* ... */]);
$promise = $client->listWorkflowRunsAsync([/* ... */]);

Lists all runs for a specified workflow, with optional pagination and filtering support.

Parameter Syntax

$result = $client->listWorkflowRuns([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkflowArn' => '<string>', // REQUIRED
    'WorkflowVersion' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of workflow runs to return in a single response.

NextToken

: Type: 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.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.

WorkflowVersion

: Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'WorkflowRuns' => [
        [
            'RunDetailSummary' => [
                'CreatedOn' => <DateTime>,
                'EndedAt' => <DateTime>,
                'StartedAt' => <DateTime>,
                'Status' => 'STARTING|QUEUED|RUNNING|SUCCESS|FAILED|TIMEOUT|STOPPING|STOPPED',
            ],
            'RunId' => '<string>',
            'RunType' => 'ON_DEMAND|SCHEDULED',
            'WorkflowArn' => '<string>',
            'WorkflowVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

WorkflowRuns

: Type: Array of WorkflowRunSummary structures

A list of workflow run summaries for the specified workflow.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

ListWorkflowVersions

$result = $client->listWorkflowVersions([/* ... */]);
$promise = $client->listWorkflowVersionsAsync([/* ... */]);

Lists all versions of a specified workflow, with optional pagination support.

Parameter Syntax

$result = $client->listWorkflowVersions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of workflow versions to return in a single response.

NextToken

: Type: 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.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow for which you want to list versions.

Result Syntax

[
    'NextToken' => '<string>',
    'WorkflowVersions' => [
        [
            'CreatedAt' => <DateTime>,
            'DefinitionS3Location' => [
                'Bucket' => '<string>',
                'ObjectKey' => '<string>',
                'VersionId' => '<string>',
            ],
            'IsLatestVersion' => true || false,
            'ModifiedAt' => <DateTime>,
            'ScheduleConfiguration' => [
                'CronExpression' => '<string>',
            ],
            'TriggerMode' => '<string>',
            'WorkflowArn' => '<string>',
            'WorkflowVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

WorkflowVersions

: Type: Array of WorkflowVersionSummary structures

A list of workflow version summaries for the specified workflow.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

ListWorkflows

$result = $client->listWorkflows([/* ... */]);
$promise = $client->listWorkflowsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listWorkflows([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of workflows you want to return in a single response.

NextToken

: Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'Workflows' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'ModifiedAt' => <DateTime>,
            'Name' => '<string>',
            'TriggerMode' => '<string>',
            'WorkflowArn' => '<string>',
            'WorkflowStatus' => 'READY|DELETING',
            'WorkflowVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

Workflows

: Required: Yes
: Type: Array of WorkflowSummary structures

A list of workflow summaries for all workflows in your account.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

StartWorkflowRun

$result = $client->startWorkflowRun([/* ... */]);
$promise = $client->startWorkflowRunAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startWorkflowRun([
    'ClientToken' => '<string>',
    'OverrideParameters' => [
        '<String>' => [
        ],
        // ...
    ],
    'WorkflowArn' => '<string>', // REQUIRED
    'WorkflowVersion' => '<string>',
]);

Parameter Details

Members

ClientToken

: Type: string

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

OverrideParameters

: Type: Associative array of custom strings keys (String) to document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documentss

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.

WorkflowArn

: Required: Yes
: Type: string

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

WorkflowVersion

: Type: string

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

Result Syntax

[
    'RunId' => '<string>',
    'StartedAt' => <DateTime>,
    'Status' => 'STARTING|QUEUED|RUNNING|SUCCESS|FAILED|TIMEOUT|STOPPING|STOPPED',
]

Result Details

Members

RunId

: Type: string

The unique identifier of the newly started workflow run.

StartedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run was started, in ISO 8601 date-time format.

Status

: Type: string

The initial status of the workflow run. This is typically STARTING when you first create the run.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.
ConflictException:: You cannot create a resource that already exists, or the resource is in a state that prevents the requested operation.
ServiceQuotaExceededException:: The request exceeds the service quota for Amazon Managed Workflows for Apache Airflow Serverless resources. This can occur when you attempt to create more workflows than allowed, exceed concurrent workflow run limits, or surpass task execution limits. Amazon Managed Workflows for Apache Airflow Serverless implements admission control using DynamoDB-based counters to manage resource utilization across the multi-tenant environment. Contact Amazon Web Services Support to request quota increases if you need higher limits for your use case.

StopWorkflowRun

$result = $client->stopWorkflowRun([/* ... */]);
$promise = $client->stopWorkflowRunAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopWorkflowRun([
    'RunId' => '<string>', // REQUIRED
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

RunId

: Required: Yes
: Type: string

The unique identifier of the workflow run to stop.

WorkflowArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'RunId' => '<string>',
    'Status' => 'STARTING|QUEUED|RUNNING|SUCCESS|FAILED|TIMEOUT|STOPPING|STOPPED',
    'WorkflowArn' => '<string>',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

RunId

: Type: string

The unique identifier of the stopped workflow run.

Status

: Type: string

The status of the workflow run after the stop operation. This is typically STOPPING or STOPPED.

WorkflowArn

: Type: string

The Amazon Resource Name (ARN) of the workflow that contains the stopped run.

WorkflowVersion

: Type: string

The version of the workflow that was stopped.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to which to add tags.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

A map of tags to add to the resource. Each tag consists of a key-value pair.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an Amazon Managed Workflows for Apache Airflow Serverless resource. This operation removes the specified tags from the resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource from which to remove tags.

TagKeys

: Required: Yes
: Type: Array of strings

A list of tag keys to remove from the resource. Only the keys are required; the values are ignored.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.

UpdateWorkflow

$result = $client->updateWorkflow([/* ... */]);
$promise = $client->updateWorkflowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateWorkflow([
    'DefinitionS3Location' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'ObjectKey' => '<string>', // REQUIRED
        'VersionId' => '<string>',
    ],
    'Description' => '<string>',
    'EngineVersion' => <integer>,
    'LoggingConfiguration' => [
        'LogGroupName' => '<string>', // REQUIRED
    ],
    'NetworkConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'TriggerMode' => '<string>',
    'WorkflowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DefinitionS3Location

: Required: Yes
: Type: DefinitionS3Location structure

The Amazon S3 location where the updated workflow definition file is stored.

Description

: Type: string

An updated description for the workflow.

EngineVersion

: Type: int

The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for the updated workflow.

LoggingConfiguration

: Type: LoggingConfiguration structure

Updated logging configuration for the workflow.

NetworkConfiguration

: Type: NetworkConfiguration structure

Updated network configuration for the workflow execution environment.

RoleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when it executes the updated workflow.

TriggerMode

: Type: string

The trigger mode for the workflow execution.

WorkflowArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'ModifiedAt' => <DateTime>,
    'Warnings' => ['<string>', ...],
    'WorkflowArn' => '<string>',
    'WorkflowVersion' => '<string>',
]

Result Details

Members

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was last modified, in ISO 8601 date-time format.

Warnings

: Type: Array of strings

Warning messages generated during workflow update.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the updated workflow.

WorkflowVersion

: Type: string

The version identifier of the updated workflow.

Errors

ThrottlingException:: The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.
ValidationException:: The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.
ResourceNotFoundException:: The specified resource was not found. You can only access or modify a resource that already exists.
AccessDeniedException:: You do not have sufficient permission to perform this action.
InternalServerException:: An unexpected server-side error occurred during request processing.
OperationTimeoutException:: The operation timed out.
ConflictException:: You cannot create a resource that already exists, or the resource is in a state that prevents the requested operation.
ServiceQuotaExceededException:: The request exceeds the service quota for Amazon Managed Workflows for Apache Airflow Serverless resources. This can occur when you attempt to create more workflows than allowed, exceed concurrent workflow run limits, or surpass task execution limits. Amazon Managed Workflows for Apache Airflow Serverless implements admission control using DynamoDB-based counters to manage resource utilization across the multi-tenant environment. Contact Amazon Web Services Support to request quota increases if you need higher limits for your use case.

Shapes

AccessDeniedException

Description

You do not have sufficient permission to perform this action.

Members

Message

: Required: Yes
: Type: string

ConflictException

Description

You cannot create a resource that already exists, or the resource is in a state that prevents the requested operation.

Members

Message

: Required: Yes
: Type: string

ResourceId

: Required: Yes
: Type: string

The unique identifier of the resource.

ResourceType

: Required: Yes
: Type: string

The type of the resource.

DefinitionS3Location

Description

Specifies the Amazon S3 location of a workflow definition file. This structure contains the bucket name, object key, and optional version ID for the workflow definition. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition file at the time of workflow creation or update, ensuring that the workflow behavior remains consistent even if the source file is modified. The definition must be a valid YAML file that uses supported Amazon Web Services operators and Amazon Managed Workflows for Apache Airflow Serverless syntax.

Members

Bucket

: Required: Yes
: Type: string

The name of the Amazon S3 bucket that contains the workflow definition file.

ObjectKey

: Required: Yes
: Type: string

The key (name) of the workflow definition file within the S3 bucket.

VersionId

: Type: string

Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.

Document

Members

EncryptionConfiguration

Description

Configuration for encrypting workflow data at rest and in transit. Amazon Managed Workflows for Apache Airflow Serverless provides comprehensive encryption capabilities to protect sensitive workflow data, parameters, and execution logs. When using customer-managed keys, the service integrates with Amazon Web Services KMS to provide fine-grained access control and audit capabilities. Encryption is applied consistently across the distributed execution environment including task containers, metadata storage, and log streams.

Members

KmsKeyId

: Type: string

The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when Type is CUSTOMER_MANAGED_KEY.

Type

: Required: Yes
: 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).

InternalServerException

Description

An unexpected server-side error occurred during request processing.

Members

Message

: Required: Yes
: Type: string

RetryAfterSeconds

: Type: int

The number of seconds to wait before retrying the operation.

LoggingConfiguration

Description

Configuration for workflow logging that specifies where you should store your workflow execution logs. Amazon Managed Workflows for Apache Airflow Serverless provides comprehensive logging capabilities that capture workflow execution details, task-level information, and system events. Logs are automatically exported to your specified CloudWatch log group using remote logging functionality, providing centralized observability across the distributed, multi-tenant execution environment. This enables effective debugging, monitoring, and compliance auditing of workflow executions.

Members

LogGroupName

: Required: Yes
: Type: string

The name of the CloudWatch log group where workflow execution logs are stored.

NetworkConfiguration

Description

Network configuration for workflow execution. Specifies VPC security groups and subnets for secure network access. When provided, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your specified VPC configuration, enabling secure access to VPC-only resources. The service uses a proxy API container architecture where one container handles external communication while the worker container connects to your VPC for task execution. This design provides both security isolation and connectivity flexibility.

Members

SecurityGroupIds

: Type: Array of strings

A list of VPC security group IDs to associate with the workflow execution environment.

SubnetIds

: Type: Array of strings

A list of VPC subnet IDs where the workflow execution environment is deployed.

OperationTimeoutException

Description

The operation timed out.

Members

Message

: Type: string

ResourceNotFoundException

Description

The specified resource was not found. You can only access or modify a resource that already exists.

Members

Message

: Required: Yes
: Type: string

ResourceId

: Required: Yes
: Type: string

The unique identifier of the resource.

ResourceType

: Required: Yes
: Type: string

The type of the resource.

RunDetailSummary

Description

Summary information about a workflow run's execution details, including status and timing information.

Members

CreatedOn

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run was created, in ISO 8601 date-time format.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

StartedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run started execution, in ISO 8601 date-time format.

Status

: Type: string

The current status of the workflow run.

ScheduleConfiguration

Description

The configuration to use to schedule automated workflow execution using cron expressions. Amazon Managed Workflows for Apache Airflow Serverless integrates with EventBridge Scheduler to provide cost-effective, timezone-aware scheduling capabilities. The service supports both time-based and event-based scheduling (event-based scheduling available post-GA). When a workflow definition includes scheduling information, Amazon Managed Workflows for Apache Airflow Serverless automatically configures the appropriate triggers and ensures only one version of a workflow has an active schedule at any time.

Members

CronExpression

: Type: string

A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.

ServiceQuotaExceededException

Description

The request exceeds the service quota for Amazon Managed Workflows for Apache Airflow Serverless resources. This can occur when you attempt to create more workflows than allowed, exceed concurrent workflow run limits, or surpass task execution limits. Amazon Managed Workflows for Apache Airflow Serverless implements admission control using DynamoDB-based counters to manage resource utilization across the multi-tenant environment. Contact Amazon Web Services Support to request quota increases if you need higher limits for your use case.

Members

Message

: Required: Yes
: Type: string

QuotaCode

: Required: Yes
: Type: string

The code of the quota.

ResourceId

: Required: Yes
: Type: string

The unique identifier of the resource.

ResourceType

: Required: Yes
: Type: string

The type of resource affected.

ServiceCode

: Required: Yes
: Type: string

The code for the service.

TaskInstanceSummary

Description

Summary information about a task instance within a workflow run, including its status and execution details.

Members

DurationInSeconds

: Type: int

The duration of the task instance execution in seconds. This value is null if the task is not complete.

OperatorName

: Type: string

The name of the Apache Airflow operator used for this task instance.

RunId

: Type: string

The unique identifier of the workflow run that contains this task instance.

Status

: Type: string

The current status of the task instance.

TaskInstanceId

: Type: string

The unique identifier of this task instance.

WorkflowArn

: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this task instance.

WorkflowVersion

: Type: string

The version of the workflow that contains this task instance.

ThrottlingException

Description

The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.

Members

Message

: Required: Yes
: Type: string

QuotaCode

: Required: Yes
: Type: string

The code of the quota.

RetryAfterSeconds

: Type: int

The number of seconds to wait before retrying the operation.

ServiceCode

: Required: Yes
: Type: string

The code for the service.

ValidationException

Description

The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.

Members

FieldList

: Type: Array of ValidationExceptionField structures

The fields that failed validation.

Message

: Required: Yes
: Type: string

Reason

: Required: Yes
: Type: string

The reason the request failed validation.

ValidationExceptionField

Description

Contains information about a field that failed validation, including the field name and a descriptive error message.

Members

Message

: Required: Yes
: Type: string

A message that describes why the field failed validation.

Name

: Required: Yes
: Type: string

The name of the field that failed validation.

WorkflowRunDetail

Description

Detailed information about a workflow run execution, including timing, status, error information, and associated task instances. This structure provides comprehensive visibility into the workflow execution lifecycle within the Amazon Managed Workflows for Apache Airflow Serverless serverless environment. The service tracks execution across distributed ECS worker tasks and provides detailed timing information, error diagnostics, and task instance relationships to support effective monitoring and troubleshooting of complex workflow executions.

Members

CompletedOn

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run was created, in ISO 8601 date-time format.

Duration

: Type: int

The total duration of the workflow run execution in seconds. This value is null if the run is not complete.

ErrorMessage

: Type: string

The error message if the workflow run failed. This value is null if the run completed successfully.

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run was last modified, in ISO 8601 date-time format.

RunId

: Type: string

The unique identifier of this workflow run.

RunState

: Type: string

The current execution state of the workflow run.

RunType

: Type: string

The type of workflow run.

StartedOn

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow run started execution, in ISO 8601 date-time format.

TaskInstances

: Type: Array of strings

A list of task instance IDs that are part of this workflow run.

WorkflowArn

: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this run.

WorkflowVersion

: Type: string

The version of the workflow used for this run.

WorkflowRunSummary

Description

Summary information about a workflow run, including basic identification and status information.

Members

RunDetailSummary

: Type: RunDetailSummary structure

Summary details about the workflow run execution.

RunId

: Type: string

The unique identifier of the workflow run.

RunType

: Type: string

The type of workflow run.

WorkflowArn

: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this run.

WorkflowVersion

: Type: string

The version of the workflow used for this run.

WorkflowSummary

Description

Summary information about a workflow, including basic identification and metadata.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was created, in ISO 8601 date-time format.

Description

: Type: string

The description of the workflow.

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow was last modified, in ISO 8601 date-time format.

Name

: Type: string

The name of the workflow.

TriggerMode

: Type: string

The trigger mode for the workflow execution.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow.

WorkflowStatus

: Type: string

The current status of the workflow.

WorkflowVersion

: Type: string

The version identifier of the workflow.

WorkflowVersionSummary

Description

Summary information about a workflow version, including identification and configuration details.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow version was created, in ISO 8601 date-time format.

DefinitionS3Location

: Type: DefinitionS3Location structure

The Amazon S3 location of the workflow definition file for this version.

IsLatestVersion

: Type: boolean

Boolean flag that indicates whether this is the latest version of the workflow.

ModifiedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the workflow version was last modified, in ISO 8601 date-time format.

ScheduleConfiguration

: Type: ScheduleConfiguration structure

The schedule configuration for this workflow version.

TriggerMode

: Type: string

The trigger mode for the workflow execution.

WorkflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow that contains this version.

WorkflowVersion

: Required: Yes
: Type: string

The version identifier of the workflow version.

AmazonMWAAServerless 2024-07-26

Operation Summary

Paginators

Operations

CreateWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetTaskInstance

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetWorkflowRun

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTaskInstances

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListWorkflowRuns

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListWorkflowVersions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListWorkflows

Parameter Syntax

Parameter Details

Members