GetWorkflow
Retrieves detailed information about a workflow, including its configuration, status, and metadata.
Request Syntax
{
"WorkflowArn": "string",
"WorkflowVersion": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- WorkflowArn
-
The Amazon Resource Name (ARN) of the workflow you want to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(?:-(?:cn|us-gov|iso|iso-b|iso-e|iso-f))?:airflow-serverless:([a-z]{2}-[a-z]+-[0-9]{1}):([0-9]{12}):workflow/([a-zA-Z0-9][a-zA-Z0-9\.\-_]{0,254}-[a-zA-Z0-9]{10})Required: Yes
- WorkflowVersion
-
Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[a-z0-9]{32}Required: No
Response Syntax
{
"CreatedAt": "string",
"DefinitionS3Location": {
"Bucket": "string",
"ObjectKey": "string",
"VersionId": "string"
},
"Description": "string",
"EncryptionConfiguration": {
"KmsKeyId": "string",
"Type": "string"
},
"EngineVersion": number,
"LoggingConfiguration": {
"LogGroupName": "string"
},
"ModifiedAt": "string",
"Name": "string",
"NetworkConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"RoleArn": "string",
"ScheduleConfiguration": {
"CronExpression": "string"
},
"TriggerMode": "string",
"WorkflowArn": "string",
"WorkflowDefinition": "string",
"WorkflowStatus": "string",
"WorkflowVersion": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreatedAt
-
The timestamp when the workflow was created, in ISO 8601 date-time format.
Type: Timestamp
- DefinitionS3Location
-
The Amazon S3 location of the workflow definition file.
Type: DefinitionS3Location object
- Description
-
The description of the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+ - EncryptionConfiguration
-
The encryption configuration for the workflow.
Type: EncryptionConfiguration object
- EngineVersion
-
The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.
Type: Integer
- LoggingConfiguration
-
The logging configuration for the workflow.
Type: LoggingConfiguration object
- ModifiedAt
-
The timestamp when the workflow was last modified, in ISO 8601 date-time format.
Type: Timestamp
- Name
-
The name of the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]* - NetworkConfiguration
-
The network configuration for the workflow execution environment.
Type: NetworkConfiguration object
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM role used for workflow execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(?:-(?:cn|us-gov|iso|iso-b|iso-e|iso-f))?:iam::[0-9]{12}:role(/[a-zA-Z0-9+=,.@_\-]{1,512})*?/[a-zA-Z0-9+=,.@_\-]{1,64} - ScheduleConfiguration
-
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.
Type: ScheduleConfiguration object
- TriggerMode
-
The trigger mode for the workflow execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
.* - WorkflowArn
-
The Amazon Resource Name (ARN) of the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(?:-(?:cn|us-gov|iso|iso-b|iso-e|iso-f))?:airflow-serverless:([a-z]{2}-[a-z]+-[0-9]{1}):([0-9]{12}):workflow/([a-zA-Z0-9][a-zA-Z0-9\.\-_]{0,254}-[a-zA-Z0-9]{10}) - WorkflowDefinition
-
The workflow definition content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
.* - WorkflowStatus
-
The current status of the workflow.
Type: String
Valid Values:
READY | DELETING - WorkflowVersion
-
The version identifier of the workflow.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[a-z0-9]{32}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permission to perform this action.
HTTP Status Code: 400
- InternalServerException
-
An unexpected server-side error occurred during request processing.
- RetryAfterSeconds
-
The number of seconds to wait before retrying the operation.
HTTP Status Code: 500
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found. You can only access or modify a resource that already exists.
- ResourceId
-
The unique identifier of the resource.
- ResourceType
-
The type of the resource.
HTTP Status Code: 400
- 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.
- QuotaCode
-
The code of the quota.
- RetryAfterSeconds
-
The number of seconds to wait before retrying the operation.
- ServiceCode
-
The code for the service.
HTTP Status Code: 400
- 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.
- FieldList
-
The fields that failed validation.
- Reason
-
The reason the request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
