LISTPIPELINES()`¶

About ListPipelines¶

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Method Signature¶

METHODS /AWS1/IF_OSI~LISTPIPELINES
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/OSIMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSINEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osilistplinsresponse
  RAISING
    /AWS1/CX_OSIACCESSDENIEDEX
    /AWS1/CX_OSIDISABLEDOPEX
    /AWS1/CX_OSIINTERNALEXCEPTION
    /AWS1/CX_OSIINVPAGINATIONTOKEX
    /AWS1/CX_OSIVALIDATIONEX
    /AWS1/CX_OSICLIENTEXC
    /AWS1/CX_OSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/OSIMAXRESULTS` `/AWS1/OSIMAXRESULTS`¶

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

`iv_nexttoken` `TYPE /AWS1/OSINEXTTOKEN` `/AWS1/OSINEXTTOKEN`¶

If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osilistplinsresponse` `/AWS1/CL_OSILISTPLINSRESPONSE`¶

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->listpipelines(
  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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_pipelines( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pipelinestatus = lo_row_1->get_status( ).
      lo_pipelinestatusreason = lo_row_1->get_statusreason( ).
      IF lo_pipelinestatusreason IS NOT INITIAL.
        lv_string = lo_pipelinestatusreason->get_description( ).
      ENDIF.
      lv_pipelinename = lo_row_1->get_pipelinename( ).
      lv_pipelinearn = lo_row_1->get_pipelinearn( ).
      lv_pipelineunits = lo_row_1->get_minunits( ).
      lv_pipelineunits = lo_row_1->get_maxunits( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_lastupdatedat( ).
      LOOP AT lo_row_1->get_destinations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_servicename( ).
          lv_string = lo_row_3->get_endpoint( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_tagkey = lo_row_5->get_key( ).
          lv_tagvalue = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_OSI=>LISTPIPELINES()¶