Skip to content

/AWS1/IF_SGM=>LISTPIPELINEEXECUTIONS()

About ListPipelineExecutions

Gets a list of the pipeline executions.

Method Signature

METHODS /AWS1/IF_SGM~LISTPIPELINEEXECUTIONS
  IMPORTING
    !IV_PIPELINENAME TYPE /AWS1/SGMPIPELINENAMEORARN OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTPIPELINEEXECSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistplinexecsrsp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_pipelinename TYPE /AWS1/SGMPIPELINENAMEORARN /AWS1/SGMPIPELINENAMEORARN

The name or Amazon Resource Name (ARN) of the pipeline.

Optional arguments:

iv_createdafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns the pipeline executions that were created after a specified time.

iv_createdbefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns the pipeline executions that were created before a specified time.

iv_sortby TYPE /AWS1/SGMSORTPIPELINEEXECSBY /AWS1/SGMSORTPIPELINEEXECSBY

The field by which to sort results. The default is CreatedTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for results.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of pipeline executions to return in the response.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistplinexecsrsp /AWS1/CL_SGMLISTPLINEXECSRSP

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->listpipelineexecutions(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pipelinename = |string|
  iv_sortby = |string|
  iv_sortorder = |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_pipelineexecutionsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pipelineexecutionarn = lo_row_1->get_pipelineexecutionarn( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_pipelineexecutionstatus = lo_row_1->get_pipelineexecutionstatus( ).
      lv_pipelineexecutiondescri = lo_row_1->get_pipelineexecutiondesc( ).
      lv_pipelineexecutionname = lo_row_1->get_pipelineexecdisplayname( ).
      lv_string3072 = lo_row_1->get_plinexecfailurereason( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.