Stop Execution

sfn_stop_execution

R Documentation

Stops an execution

Description

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.

Usage

sfn_stop_execution(executionArn, error, cause)

Arguments

executionArn

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

error

The error code of the failure.

cause

A more detailed explanation of the cause of the failure.

Value

A list with the following syntax:

list(
  stopDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$stop_execution(
  executionArn = "string",
  error = "string",
  cause = "string"
)