# StopWorkflowRun
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.
## Request Syntax
```
{
"RunId": "string",
"WorkflowArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RunId](#API_StopWorkflowRun_RequestSyntax) **
The unique identifier of the workflow run to stop.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*`
Required: Yes
** [WorkflowArn](#API_StopWorkflowRun_RequestSyntax) **
The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.
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
## Response Syntax
```
{
"RunId": "string",
"Status": "string",
"WorkflowArn": "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.
** [RunId](#API_StopWorkflowRun_ResponseSyntax) **
The unique identifier of the stopped workflow run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*`
** [Status](#API_StopWorkflowRun_ResponseSyntax) **
The status of the workflow run after the stop operation. This is typically `STOPPING` or `STOPPED`.
Type: String
Valid Values: `STARTING | QUEUED | RUNNING | SUCCESS | FAILED | TIMEOUT | STOPPING | STOPPED`
** [WorkflowArn](#API_StopWorkflowRun_ResponseSyntax) **
The Amazon Resource Name (ARN) of the workflow that contains the stopped run.
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})`
** [WorkflowVersion](#API_StopWorkflowRun_ResponseSyntax) **
The version of the workflow that was stopped.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mwaa-serverless-2024-07-26/StopWorkflowRun)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mwaa-serverless-2024-07-26/StopWorkflowRun)