Skip to content

/AWS1/IF_PIS=>LISTPIPES()

About ListPipes

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Method Signature

METHODS /AWS1/IF_PIS~LISTPIPES
  IMPORTING
    !IV_NAMEPREFIX TYPE /AWS1/PISPIPENAME OPTIONAL
    !IV_DESIREDSTATE TYPE /AWS1/PISREQUESTEDPIPESTATE OPTIONAL
    !IV_CURRENTSTATE TYPE /AWS1/PISPIPESTATE OPTIONAL
    !IV_SOURCEPREFIX TYPE /AWS1/PISRESOURCEARN OPTIONAL
    !IV_TARGETPREFIX TYPE /AWS1/PISRESOURCEARN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PISNEXTTOKEN OPTIONAL
    !IV_LIMIT TYPE /AWS1/PISLIMITMAX100 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pislistpipesresponse
  RAISING
    /AWS1/CX_PISINTERNALEXCEPTION
    /AWS1/CX_PISTHROTTLINGEX
    /AWS1/CX_PISVALIDATIONEX
    /AWS1/CX_PISCLIENTEXC
    /AWS1/CX_PISSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_nameprefix TYPE /AWS1/PISPIPENAME /AWS1/PISPIPENAME

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

iv_desiredstate TYPE /AWS1/PISREQUESTEDPIPESTATE /AWS1/PISREQUESTEDPIPESTATE

The state the pipe should be in.

iv_currentstate TYPE /AWS1/PISPIPESTATE /AWS1/PISPIPESTATE

The state the pipe is in.

iv_sourceprefix TYPE /AWS1/PISRESOURCEARN /AWS1/PISRESOURCEARN

The prefix matching the pipe source.

iv_targetprefix TYPE /AWS1/PISRESOURCEARN /AWS1/PISRESOURCEARN

The prefix matching the pipe target.

iv_nexttoken TYPE /AWS1/PISNEXTTOKEN /AWS1/PISNEXTTOKEN

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

iv_limit TYPE /AWS1/PISLIMITMAX100 /AWS1/PISLIMITMAX100

The maximum number of pipes to include in the response.

RETURNING

oo_output TYPE REF TO /aws1/cl_pislistpipesresponse /AWS1/CL_PISLISTPIPESRESPONSE

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->listpipes(
  iv_currentstate = |string|
  iv_desiredstate = |string|
  iv_limit = 123
  iv_nameprefix = |string|
  iv_nexttoken = |string|
  iv_sourceprefix = |string|
  iv_targetprefix = |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_pipes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pipename = lo_row_1->get_name( ).
      lv_pipearn = lo_row_1->get_arn( ).
      lv_requestedpipestate = lo_row_1->get_desiredstate( ).
      lv_pipestate = lo_row_1->get_currentstate( ).
      lv_pipestatereason = lo_row_1->get_statereason( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_arnorurl = lo_row_1->get_source( ).
      lv_arn = lo_row_1->get_target( ).
      lv_optionalarn = lo_row_1->get_enrichment( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.