LISTSTREAMS()`¶

About ListStreams¶

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

Method Signature¶

METHODS /AWS1/IF_KNV~LISTSTREAMS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/KNVLISTSTREAMSINPUTLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KNVNEXTTOKEN OPTIONAL
    !IO_STREAMNAMECONDITION TYPE REF TO /AWS1/CL_KNVSTREAMNAMECOND OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvliststreamsoutput
  RAISING
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/KNVLISTSTREAMSINPUTLIMIT` `/AWS1/KNVLISTSTREAMSINPUTLIMIT`¶

The maximum number of streams to return in the response. The default is 10,000.

`iv_nexttoken` `TYPE /AWS1/KNVNEXTTOKEN` `/AWS1/KNVNEXTTOKEN`¶

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

`io_streamnamecondition` `TYPE REF TO /AWS1/CL_KNVSTREAMNAMECOND` `/AWS1/CL_KNVSTREAMNAMECOND`¶

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knvliststreamsoutput` `/AWS1/CL_KNVLISTSTREAMSOUTPUT`¶

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->liststreams(
  io_streamnamecondition = new /aws1/cl_knvstreamnamecond(
    iv_comparisonoperator = |string|
    iv_comparisonvalue = |string|
  )
  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.
  LOOP AT lo_result->get_streaminfolist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_devicename = lo_row_1->get_devicename( ).
      lv_streamname = lo_row_1->get_streamname( ).
      lv_resourcearn = lo_row_1->get_streamarn( ).
      lv_mediatype = lo_row_1->get_mediatype( ).
      lv_kmskeyid = lo_row_1->get_kmskeyid( ).
      lv_version = lo_row_1->get_version( ).
      lv_status = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_dataretentioninhours = lo_row_1->get_dataretentioninhours( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_KNV=>LISTSTREAMS()¶