Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StopExecution

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 Amazon KMS key for the execution role.

A caller can stop an execution without using any Amazon 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.

Request Syntax


{
   "cause": "string",
   "error": "string",
   "executionArn": "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.

cause

A more detailed explanation of the cause of the failure.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32768.

Required: No

error

The error code of the failure.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

executionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax


{
   "stopDate": number
}

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.

stopDate

The date the execution is stopped.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ExecutionDoesNotExist

The specified execution does not exist.

HTTP Status Code: 400

InvalidArn

The provided Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

KmsAccessDeniedException

Either your Amazon KMS key policy or API caller does not have the required permissions.

HTTP Status Code: 400

KmsInvalidStateException

The Amazon KMS key is not in valid state, for example: Disabled or Deleted.

HTTP Status Code: 400

KmsThrottlingException

Received when Amazon KMS returns ThrottlingException for a Amazon KMS call that Step Functions makes on behalf of the caller.

HTTP Status Code: 400

ValidationException

The input does not satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400