Stops an execution that is in progress in a flow.
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RequestId | string | No | The request ID. If you specify this parameter, the system uses this value as the ID of the request. If you do not specify this parameter, the system generates a value at random. | testRequestId |
FlowName | string | Yes | The name of the flow in which that you want to stop the execution. You can call the ListFlows operation to obtain the value of this parameter. The name is unique within the same region and cannot be modified after the flow is created. Set this parameter based on the following rules:
| flow |
ExecutionName | string | Yes | The name of the execution that you want to stop. You can call the ListExecutions operation to obtain the value of this parameter. The name is unique in a flow. Set this parameter based on the following rules:
| exec |
Cause | string | No | The reason for stopping the execution. The value must be 1 to 4,096 characters in length. | for test |
Error | string | No | The error for stopping the execution. The value must be 1 to 128 characters in length. | nill |
Response parameters
Examples
Sample success responses
JSON
format
{
"Status": "Running",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId",
"StartedTime": "2019-01-01T01:01:01.001Z",
"FlowDefinition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
"Output": "{\"key\":\"value\"}",
"FlowName": "flow",
"Name": "exec",
"Input": "{\"key\":\"value\"}"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | - |
400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | - |
400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | The payload size exceeds maximum allowed size (%s bytes). |
400 | ExecutionAlreadyCompleted | Execution '%s' for flow '%s' has already completed. | - |
400 | InvalidArgument | Parameter error. | Parameter error. |
400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | The HTTP header '%s' must be specified. |
400 | MissingRequiredParams | The HTTP query '%s' must be specified. | The HTTP query '%s' must be specified. |
403 | AccessDenied | The resources doesn't belong to you. | - |
403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | The AccessKey ID %s is invalid. |
403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | The difference between the request time %s and the current time %s is too large. |
403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm. |
404 | ExecutionNotExists | Execution %s for flow %s does not exist. | Execution %s for flow %s does not exist. |
404 | FlowNotExists | Flow %s does not exist. | Flow %s does not exist. |
409 | ConcurrentUpdateError | Update conflict, please retry. | Update conflict, please retry. |
415 | UnsupportedMediaType | The content type must be "application/json". | The content type must be "application/json". |
429 | ResourceThrottled | The request is throttled. Please try again later. | The request is throttled. Please try again later. |
500 | InternalServerError | An internal error has occurred. Please retry. | An internal error has occurred. Please retry. |
For a list of error codes, visit the Service error codes.