Menu
AWS Step Functions
API Reference (API Version 2016-11-23)

StopExecution

Stops an execution.

Request Syntax

Copy
{ "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 termination.

Type: String

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

Required: No

error

An arbitrary error code that identifies the cause of the termination.

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

Copy
{ "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 invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: