/AWS1/CL_SWF=>DESCRIBEWORKFLOWEXECUTION()

About DescribeWorkflowExecution

Returns information about the specified workflow execution including its type and some statistics.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Method Signature

IMPORTING

Required arguments:

iv_domain TYPE /AWS1/SWFDOMAINNAME /AWS1/SWFDOMAINNAME

The name of the domain containing the workflow execution.

io_execution TYPE REF TO /AWS1/CL_SWFWORKFLOWEXECUTION /AWS1/CL_SWFWORKFLOWEXECUTION

The workflow execution to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_swfworkflowexecdetail /AWS1/CL_SWFWORKFLOWEXECDETAIL

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->/aws1/if_swf~describeworkflowexecution(
  io_execution = new /aws1/cl_swfworkflowexecution(
    iv_runid = |string|
    iv_workflowid = |string|
  )
  iv_domain = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_workflowexecutioninfo = lo_result->get_executioninfo( ).
  IF lo_workflowexecutioninfo IS NOT INITIAL.
    lo_workflowexecution = lo_workflowexecutioninfo->get_execution( ).
    IF lo_workflowexecution IS NOT INITIAL.
      lv_workflowid = lo_workflowexecution->get_workflowid( ).
      lv_workflowrunid = lo_workflowexecution->get_runid( ).
    ENDIF.
    lo_workflowtype = lo_workflowexecutioninfo->get_workflowtype( ).
    IF lo_workflowtype IS NOT INITIAL.
      lv_name = lo_workflowtype->get_name( ).
      lv_version = lo_workflowtype->get_version( ).
    ENDIF.
    lv_timestamp = lo_workflowexecutioninfo->get_starttimestamp( ).
    lv_timestamp = lo_workflowexecutioninfo->get_closetimestamp( ).
    lv_executionstatus = lo_workflowexecutioninfo->get_executionstatus( ).
    lv_closestatus = lo_workflowexecutioninfo->get_closestatus( ).
    lo_workflowexecution = lo_workflowexecutioninfo->get_parent( ).
    IF lo_workflowexecution IS NOT INITIAL.
      lv_workflowid = lo_workflowexecution->get_workflowid( ).
      lv_workflowrunid = lo_workflowexecution->get_runid( ).
    ENDIF.
    LOOP AT lo_workflowexecutioninfo->get_taglist( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tag = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_canceled = lo_workflowexecutioninfo->get_cancelrequested( ).
  ENDIF.
  lo_workflowexecutionconfig = lo_result->get_executionconfiguration( ).
  IF lo_workflowexecutionconfig IS NOT INITIAL.
    lv_durationinseconds = lo_workflowexecutionconfig->get_taskstarttoclosetimeout( ).
    lv_durationinseconds = lo_workflowexecutionconfig->get_execstarttoclosetimeout( ).
    lo_tasklist = lo_workflowexecutionconfig->get_tasklist( ).
    IF lo_tasklist IS NOT INITIAL.
      lv_name = lo_tasklist->get_name( ).
    ENDIF.
    lv_taskpriority = lo_workflowexecutionconfig->get_taskpriority( ).
    lv_childpolicy = lo_workflowexecutionconfig->get_childpolicy( ).
    lv_arn = lo_workflowexecutionconfig->get_lambdarole( ).
  ENDIF.
  lo_workflowexecutionopenco = lo_result->get_opencounts( ).
  IF lo_workflowexecutionopenco IS NOT INITIAL.
    lv_count = lo_workflowexecutionopenco->get_openactivitytasks( ).
    lv_opendecisiontaskscount = lo_workflowexecutionopenco->get_opendecisiontasks( ).
    lv_count = lo_workflowexecutionopenco->get_opentimers( ).
    lv_count = lo_workflowexecutionopenco->get_openchildworkflowexecs( ).
    lv_count = lo_workflowexecutionopenco->get_openlambdafunctions( ).
  ENDIF.
  lv_timestamp = lo_result->get_latestactivitytasktsmp( ).
  lv_data = lo_result->get_latestexecutioncontext( ).
ENDIF.