STOPEXECUTION()`¶

About 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 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.

Method Signature¶

METHODS /AWS1/IF_SFN~STOPEXECUTION
  IMPORTING
    !IV_EXECUTIONARN TYPE /AWS1/SFNARN OPTIONAL
    !IV_ERROR TYPE /AWS1/SFNSENSITIVEERROR OPTIONAL
    !IV_CAUSE TYPE /AWS1/SFNSENSITIVECAUSE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sfnstopexecoutput
  RAISING
    /AWS1/CX_SFNEXECDOESNOTEXIST
    /AWS1/CX_SFNINVALIDARN
    /AWS1/CX_SFNKMSACCESSDENIEDEX
    /AWS1/CX_SFNKMSINVALIDSTATEEX
    /AWS1/CX_SFNKMSTHROTTLINGEX
    /AWS1/CX_SFNVALIDATIONEX
    /AWS1/CX_SFNCLIENTEXC
    /AWS1/CX_SFNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_executionarn` `TYPE /AWS1/SFNARN` `/AWS1/SFNARN`¶

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

Optional arguments:¶

`iv_error` `TYPE /AWS1/SFNSENSITIVEERROR` `/AWS1/SFNSENSITIVEERROR`¶

The error code of the failure.

`iv_cause` `TYPE /AWS1/SFNSENSITIVECAUSE` `/AWS1/SFNSENSITIVECAUSE`¶

A more detailed explanation of the cause of the failure.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sfnstopexecoutput` `/AWS1/CL_SFNSTOPEXECOUTPUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->stopexecution(
  iv_cause = |string|
  iv_error = |string|
  iv_executionarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_timestamp = lo_result->get_stopdate( ).
ENDIF.

/AWS1/IF_SFN=>STOPEXECUTION()¶