v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1737274251.5 KB

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

post/#X-Amz-Target=AWSStepFunctions.StopExecution

Headers

X-Amz-Target'AWSStepFunctions.StopExecution' required

Request body

executionArnstring required

The Amazon Resource Name (ARN) of the execution to stop.

errorstring password

The error code of the failure.

causestring password

A more detailed explanation of the cause of the failure.

Response

Success

stopDatestring date-time required

The date the execution is stopped.