StopExecution

Stops an execution.

This API action is not supported by EXPRESS state machines.

Request Syntax


{
   "cause": "string",
   "error": "string",
   "executionArn": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

A more detailed explanation of the cause of the failure.

Type: String

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

Required: No

The error code of the failure.

Type: String

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

Required: No

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

Type: String

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

Required: Yes


{
   "stopDate": number
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The date the execution is stopped.

Type: Timestamp

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

ValidationException

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

HTTP Status Code: 400