DESCRIBEPIPELINEEXECUTION()`¶

About DescribePipelineExecution¶

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

Method Signature¶

METHODS /AWS1/IF_IOS~DESCRIBEPIPELINEEXECUTION
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_PIPELINENAME TYPE /AWS1/IOSRESOURCENAME OPTIONAL
    !IV_PIPELINEEXECUTIONID TYPE /AWS1/IOSID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSDSCPLEXEREQMAXRSLTINT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosdescrplinexecrsp
  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.

`iv_pipelineexecutionid` `TYPE /AWS1/IOSID` `/AWS1/IOSID`¶

The unique identifier of the pipeline execution.

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/IOSDSCPLEXEREQMAXRSLTINT` `/AWS1/IOSDSCPLEXEREQMAXRSLTINT`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosdescrplinexecrsp` `/AWS1/CL_IOSDESCRPLINEXECRSP`¶

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->describepipelineexecution(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pipelineexecutionid = |string|
  iv_pipelinename = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_pipelineexecutionid( ).
  lv_resourcename = lo_result->get_pipelinename( ).
  lv_workspacename = lo_result->get_workspacename( ).
  lv_version = lo_result->get_pipelineversion( ).
  lo_pipelineexecutionstatus = lo_result->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.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_detailedpipelineerrorco = lo_row_1->get_code( ).
          lv_string = lo_row_1->get_message( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
  lv_timestamp = lo_result->get_starttime( ).
  lv_timestamp = lo_result->get_endtime( ).
  lo_executionenvironmentvar = lo_result->get_requestenvvariables( ).
  IF lo_executionenvironmentvar IS NOT INITIAL.
    LOOP AT lo_executionenvironmentvar->get_global( ) into ls_row_2.
      lv_key = ls_row_2-key.
      lo_value = ls_row_2-value.
      IF lo_value IS NOT INITIAL.
        lv_environmentvariablevalu = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_executionenvironmentvar->get_computenodes( ) into ls_row_3.
      lv_key_1 = ls_row_3-key.
      LOOP AT ls_row_3-value into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_environmentvariablevalu = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDLOOP.
  ENDIF.
  lv_executionpriority = lo_result->get_executionpriority( ).
  LOOP AT lo_result->get_computenodeexecdetails( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_resourcename = lo_row_5->get_computenodename( ).
      lv_resourcename = lo_row_5->get_taskname( ).
      lv_arn = lo_row_5->get_taskarn( ).
      lv_version = lo_row_5->get_taskversion( ).
      LOOP AT lo_row_5->get_dependson( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_resourcename = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_computenodeexecutionsta = lo_row_5->get_status( ).
      IF lo_computenodeexecutionsta IS NOT INITIAL.
        lv_computenodeexecutionsta_1 = lo_computenodeexecutionsta->get_state( ).
        lo_computenodeexecutionsta_2 = lo_computenodeexecutionsta->get_statedetails( ).
        IF lo_computenodeexecutionsta_2 IS NOT INITIAL.
          lv_computenodeerrorcode = lo_computenodeexecutionsta_2->get_code( ).
          lv_string = lo_computenodeexecutionsta_2->get_message( ).
          LOOP AT lo_computenodeexecutionsta_2->get_details( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_detailedpipelineerrorco = lo_row_1->get_code( ).
              lv_string = lo_row_1->get_message( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lv_timestamp_1 = lo_row_5->get_starttime( ).
      lv_timestamp_1 = lo_row_5->get_endtime( ).
      LOOP AT lo_row_5->get_executionenvvariables( ) into ls_row_8.
        lv_key_2 = ls_row_8-key.
        lo_value_1 = ls_row_8-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_executionenvironmentvar_1 = lo_value_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOS=>DESCRIBEPIPELINEEXECUTION()¶