LISTSTREAMS()`¶

About ListStreams¶

Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.

Method Signature¶

METHODS /AWS1/IF_KYZ~LISTSTREAMS
  IMPORTING
    !IV_KEYSPACENAME TYPE /AWS1/KYZKEYSPACENAME OPTIONAL
    !IV_TABLENAME TYPE /AWS1/KYZTABLENAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/KYZINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KYZSTREAMARNTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kyzliststreamsoutput
  RAISING
    /AWS1/CX_KYZACCESSDENIEDEX
    /AWS1/CX_KYZINTERNALSERVEREX
    /AWS1/CX_KYZRESOURCENOTFOUNDEX
    /AWS1/CX_KYZTHROTTLINGEX
    /AWS1/CX_KYZVALIDATIONEX
    /AWS1/CX_KYZCLIENTEXC
    /AWS1/CX_KYZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_keyspacename` `TYPE /AWS1/KYZKEYSPACENAME` `/AWS1/KYZKEYSPACENAME`¶

The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.

`iv_tablename` `TYPE /AWS1/KYZTABLENAME` `/AWS1/KYZTABLENAME`¶

The name of the table for which to list streams. Must be used together with keyspaceName. If specified, only streams associated with this specific table are returned.

`iv_maxresults` `TYPE /AWS1/KYZINTEGER` `/AWS1/KYZINTEGER`¶

The maximum number of streams to return in a single ListStreams request. Default value is 100. The minimum value is 1 and the maximum value is 100.

`iv_nexttoken` `TYPE /AWS1/KYZSTREAMARNTOKEN` `/AWS1/KYZSTREAMARNTOKEN`¶

An optional pagination token provided by a previous ListStreams operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kyzliststreamsoutput` `/AWS1/CL_KYZLISTSTREAMSOUTPUT`¶

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(
  iv_keyspacename = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  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_keyspacename = lo_row_1->get_keyspacename( ).
      lv_tablename = lo_row_1->get_tablename( ).
      lv_string = lo_row_1->get_streamlabel( ).
    ENDIF.
  ENDLOOP.
  lv_streamarntoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_KYZ=>LISTSTREAMS()¶