Skip to content

/AWS1/IF_IOS=>LISTPIPELINEEXECUTIONS()

About ListPipelineExecutions

Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

Method Signature

METHODS /AWS1/IF_IOS~LISTPIPELINEEXECUTIONS
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_PIPELINENAME TYPE /AWS1/IOSRESOURCENAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSLSTPLEXEREQMAXRSLTINT OPTIONAL
    !IV_STATE TYPE /AWS1/IOSPIPELINEEXECSTATE OPTIONAL
    !IV_STARTTIMEAFTER TYPE /AWS1/IOSTIMESTAMP OPTIONAL
    !IV_STARTTIMEBEFORE TYPE /AWS1/IOSTIMESTAMP OPTIONAL
    !IV_ENDTIMEAFTER TYPE /AWS1/IOSTIMESTAMP OPTIONAL
    !IV_ENDTIMEBEFORE TYPE /AWS1/IOSTIMESTAMP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslistplinexecsrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME

The name of the workspace.

iv_pipelinename TYPE /AWS1/IOSRESOURCENAME /AWS1/IOSRESOURCENAME

The name of the pipeline.

Optional arguments:

iv_nexttoken TYPE /AWS1/IOSPAGINATIONTOKEN /AWS1/IOSPAGINATIONTOKEN

The token to be used for the next set of paginated results.

iv_maxresults TYPE /AWS1/IOSLSTPLEXEREQMAXRSLTINT /AWS1/IOSLSTPLEXEREQMAXRSLTINT

The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

iv_state TYPE /AWS1/IOSPIPELINEEXECSTATE /AWS1/IOSPIPELINEEXECSTATE

Filter by execution state. If not specified, executions in all states are returned.

iv_starttimeafter TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

iv_starttimebefore TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

iv_endtimeafter TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

iv_endtimebefore TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioslistplinexecsrsp /AWS1/CL_IOSLISTPLINEXECSRSP

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->listpipelineexecutions(
  iv_endtimeafter = '20150101000000.0000000'
  iv_endtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pipelinename = |string|
  iv_starttimeafter = '20150101000000.0000000'
  iv_starttimebefore = '20150101000000.0000000'
  iv_state = |string|
  iv_workspacename = |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_pipelineexecsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_pipelineexecutionid( ).
      lv_version = lo_row_1->get_pipelineversion( ).
      lo_pipelineexecutionstatus = lo_row_1->get_status( ).
      IF lo_pipelineexecutionstatus IS NOT INITIAL.
        lv_pipelineexecutionstate = lo_pipelineexecutionstatus->get_state( ).
        lo_pipelineexecutionstated = lo_pipelineexecutionstatus->get_statedetails( ).
        IF lo_pipelineexecutionstated IS NOT INITIAL.
          lv_pipelineerrorcode = lo_pipelineexecutionstated->get_code( ).
          lv_string = lo_pipelineexecutionstated->get_message( ).
          LOOP AT lo_pipelineexecutionstated->get_details( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_detailedpipelineerrorco = lo_row_3->get_code( ).
              lv_string = lo_row_3->get_message( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lv_executionpriority = lo_row_1->get_executionpriority( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.