15

I was reading the API documentation an there's an action called StopExecution.

https://docs.aws.amazon.com/step-functions/latest/apireference/API_StopExecution.html

I was wondering what it does. Yes, of course, it stops the execution, but what if some task is running? Does it send a signal to stop the task like SWF does? Or just revoke the TaskToken (so the task cannot send the results back) and leave it running? Does the same happens if the task is a lambda function?

I was thinking about this because I have some long running tasks and could not find this behavior documented anywhere.

My guess: It just signals the execution as stopped and leave the task running. When the tasks calls SendTaskSuccess, it just receives an error like InvalidToken.

MatthewMartin
  • 32,326
  • 33
  • 105
  • 164
drpexe
  • 466
  • 4
  • 13

2 Answers2

10

I did the testing and it turns out that SFN does absolutely nothing to stop a running task. However, if you try to SendTaskHeartbeat on a stopped execution it will throw a TaskTimedOut error.

What I ended up doing was to verify the output of SendTaskHeartbeat, catch TaskTimedOut and proceed with the task cancellation on the worker side.

Note: The same TaskTimedOut error happens on SendTaskSuccess/SendTaskFailure.

drpexe
  • 466
  • 4
  • 13
3

In the case of Batch job, it does stop the step and the Job Terminate with exitCode 1 and the following reason: Status reason: The Task state in AWS Step Functions execution [arn:aws:states:us-west-2:12345678912:execution:JobStateMachine:00000-c583-2050-f8b1-9d36e05f4266] which was managing this resource was aborted

user1331590
  • 31
  • 2
  • One note on this is that you must have both `batch:SubmitJob` and `batch:TerminateJob` granted against the state machine. I don't know how to restrict this to certain queues though. – Brett Ryan Jul 22 '21 at 02:03