LISTSTREAMS()`¶

About ListStreams¶

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

Method Signature¶

METHODS /AWS1/IF_IVS~LISTSTREAMS
  IMPORTING
    !IO_FILTERBY TYPE REF TO /AWS1/CL_IVSSTREAMFILTERS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IVSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IVSMAXSTREAMRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivsliststreamsrsp
  RAISING
    /AWS1/CX_IVSACCESSDENIEDEX
    /AWS1/CX_IVSVALIDATIONEX
    /AWS1/CX_IVSCLIENTEXC
    /AWS1/CX_IVSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`io_filterby` `TYPE REF TO /AWS1/CL_IVSSTREAMFILTERS` `/AWS1/CL_IVSSTREAMFILTERS`¶

Filters the stream list to match the specified criterion.

`iv_nexttoken` `TYPE /AWS1/IVSPAGINATIONTOKEN` `/AWS1/IVSPAGINATIONTOKEN`¶

The first stream to retrieve. This is used for pagination; see the nextToken response field.

`iv_maxresults` `TYPE /AWS1/IVSMAXSTREAMRESULTS` `/AWS1/IVSMAXSTREAMRESULTS`¶

Maximum number of streams to return. Default: 100.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ivsliststreamsrsp` `/AWS1/CL_IVSLISTSTREAMSRSP`¶

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_filterby = new /aws1/cl_ivsstreamfilters( |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_streams( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_channelarn = lo_row_1->get_channelarn( ).
      lv_streamid = lo_row_1->get_streamid( ).
      lv_streamstate = lo_row_1->get_state( ).
      lv_streamhealth = lo_row_1->get_health( ).
      lv_streamviewercount = lo_row_1->get_viewercount( ).
      lv_streamstarttime = lo_row_1->get_starttime( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IVS=>LISTSTREAMS()¶