Skip to content

/AWS1/CL_DYS=>LISTSTREAMS()

About ListStreams

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second.

Method Signature

IMPORTING

Optional arguments:

iv_tablename TYPE /AWS1/DYSTABLENAME /AWS1/DYSTABLENAME

If this parameter is provided, then only the streams associated with this table name are returned.

iv_limit TYPE /AWS1/DYSPOSITIVEINTEGEROBJECT /AWS1/DYSPOSITIVEINTEGEROBJECT

The maximum number of streams to return. The upper limit is 100.

iv_exclusivestartstreamarn TYPE /AWS1/DYSSTREAMARN /AWS1/DYSSTREAMARN

The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

RETURNING

oo_output TYPE REF TO /aws1/cl_dysliststreamsoutput /AWS1/CL_DYSLISTSTREAMSOUTPUT

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->/aws1/if_dys~liststreams(
  iv_exclusivestartstreamarn = |string|
  iv_limit = 123
  iv_tablename = |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_streams( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_streamarn = lo_row_1->get_streamarn( ).
      lv_tablename = lo_row_1->get_tablename( ).
      lv_string = lo_row_1->get_streamlabel( ).
    ENDIF.
  ENDLOOP.
  lv_streamarn = lo_result->get_lastevaluatedstreamarn( ).
ENDIF.

To list all of the stream ARNs

The following example lists all of the stream ARNs.

DATA(lo_result) = lo_client->/aws1/if_dys~liststreams( ).