Skip to content

/AWS1/IF_BDZ=>LISTFLOWEXECUTIONS()

About ListFlowExecutions

Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).

Flow executions is in preview release for Amazon Bedrock and is subject to change.

Method Signature

METHODS /AWS1/IF_BDZ~LISTFLOWEXECUTIONS
  IMPORTING
    !IV_FLOWIDENTIFIER TYPE /AWS1/BDZFLOWIDENTIFIER OPTIONAL
    !IV_FLOWALIASIDENTIFIER TYPE /AWS1/BDZFLOWALIASIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDZMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDZNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdzlistflowexecsrsp
  RAISING
    /AWS1/CX_BDZACCESSDENIEDEX
    /AWS1/CX_BDZINTERNALSERVEREX
    /AWS1/CX_BDZRESOURCENOTFOUNDEX
    /AWS1/CX_BDZTHROTTLINGEX
    /AWS1/CX_BDZVALIDATIONEX
    /AWS1/CX_BDZCLIENTEXC
    /AWS1/CX_BDZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_flowidentifier TYPE /AWS1/BDZFLOWIDENTIFIER /AWS1/BDZFLOWIDENTIFIER

The unique identifier of the flow to list executions for.

Optional arguments:

iv_flowaliasidentifier TYPE /AWS1/BDZFLOWALIASIDENTIFIER /AWS1/BDZFLOWALIASIDENTIFIER

The unique identifier of the flow alias to list executions for.

iv_maxresults TYPE /AWS1/BDZMAXRESULTS /AWS1/BDZMAXRESULTS

The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

iv_nexttoken TYPE /AWS1/BDZNEXTTOKEN /AWS1/BDZNEXTTOKEN

A token to retrieve the next set of results. This value is returned in the response if more results are available.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdzlistflowexecsrsp /AWS1/CL_BDZLISTFLOWEXECSRSP

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->listflowexecutions(
  iv_flowaliasidentifier = |string|
  iv_flowidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_flowexecutionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_flowexecutionidentifier = lo_row_1->get_executionarn( ).
      lv_flowaliasidentifier = lo_row_1->get_flowaliasidentifier( ).
      lv_flowidentifier = lo_row_1->get_flowidentifier( ).
      lv_version = lo_row_1->get_flowversion( ).
      lv_flowexecutionstatus = lo_row_1->get_status( ).
      lv_datetimestamp = lo_row_1->get_createdat( ).
      lv_datetimestamp = lo_row_1->get_endedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.