Skip to content

/AWS1/IF_MWS=>STOPWORKFLOWRUN()

About StopWorkflowRun

Stops a running workflow execution. This operation terminates all running tasks and prevents new tasks from starting. Amazon Managed Workflows for Apache Airflow Serverless gracefully shuts down the workflow execution by stopping task scheduling and terminating active ECS worker containers. The operation transitions the workflow run to a STOPPING state and then to STOPPED once all cleanup is complete. In-flight tasks may complete or be terminated depending on their current execution state.

Method Signature

METHODS /AWS1/IF_MWS~STOPWORKFLOWRUN
  IMPORTING
    !IV_WORKFLOWARN TYPE /AWS1/MWSWORKFLOWARN OPTIONAL
    !IV_RUNID TYPE /AWS1/MWSIDSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mwsstopworkflowrunrsp
  RAISING
    /AWS1/CX_MWSACCESSDENIEDEX
    /AWS1/CX_MWSINTERNALSERVEREX
    /AWS1/CX_MWSOPERATIONTIMEOUTEX
    /AWS1/CX_MWSRESOURCENOTFOUNDEX
    /AWS1/CX_MWSTHROTTLINGEX
    /AWS1/CX_MWSVALIDATIONEX
    /AWS1/CX_MWSCLIENTEXC
    /AWS1/CX_MWSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_workflowarn TYPE /AWS1/MWSWORKFLOWARN /AWS1/MWSWORKFLOWARN

The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.

iv_runid TYPE /AWS1/MWSIDSTRING /AWS1/MWSIDSTRING

The unique identifier of the workflow run to stop.

RETURNING

oo_output TYPE REF TO /aws1/cl_mwsstopworkflowrunrsp /AWS1/CL_MWSSTOPWORKFLOWRUNRSP

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->stopworkflowrun(
  iv_runid = |string|
  iv_workflowarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workflowarn = lo_result->get_workflowarn( ).
  lv_versionid = lo_result->get_workflowversion( ).
  lv_idstring = lo_result->get_runid( ).
  lv_workflowrunstatus = lo_result->get_status( ).
ENDIF.