Skip to content

/AWS1/CL_KNV=>LISTEDGEAGENTCONFIGURATIONS()

About ListEdgeAgentConfigurations

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

Method Signature

IMPORTING

Required arguments:

iv_hubdevicearn TYPE /AWS1/KNVHUBDEVICEARN /AWS1/KNVHUBDEVICEARN

The "Internet of Things (IoT) Thing" Arn of the edge agent.

Optional arguments:

iv_maxresults TYPE /AWS1/KNVLSTEDGEAGENTCONFSIN00 /AWS1/KNVLSTEDGEAGENTCONFSIN00

The maximum number of edge configurations to return in the response. The default is 5.

iv_nexttoken TYPE /AWS1/KNVNEXTTOKEN /AWS1/KNVNEXTTOKEN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_knvlstedgeagentconf01 /AWS1/CL_KNVLSTEDGEAGENTCONF01

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_knv~listedgeagentconfigurations(
  iv_hubdevicearn = |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_edgeconfigs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_streamname = lo_row_1->get_streamname( ).
      lv_resourcearn = lo_row_1->get_streamarn( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastupdatedtime( ).
      lv_syncstatus = lo_row_1->get_syncstatus( ).
      lv_failedstatusdetails = lo_row_1->get_failedstatusdetails( ).
      lo_edgeconfig = lo_row_1->get_edgeconfig( ).
      IF lo_edgeconfig IS NOT INITIAL.
        lv_hubdevicearn = lo_edgeconfig->get_hubdevicearn( ).
        lo_recorderconfig = lo_edgeconfig->get_recorderconfig( ).
        IF lo_recorderconfig IS NOT INITIAL.
          lo_mediasourceconfig = lo_recorderconfig->get_mediasourceconfig( ).
          IF lo_mediasourceconfig IS NOT INITIAL.
            lv_mediaurisecretarn = lo_mediasourceconfig->get_mediaurisecretarn( ).
            lv_mediauritype = lo_mediasourceconfig->get_mediauritype( ).
          ENDIF.
          lo_scheduleconfig = lo_recorderconfig->get_scheduleconfig( ).
          IF lo_scheduleconfig IS NOT INITIAL.
            lv_scheduleexpression = lo_scheduleconfig->get_scheduleexpression( ).
            lv_durationinseconds = lo_scheduleconfig->get_durationinseconds( ).
          ENDIF.
        ENDIF.
        lo_uploaderconfig = lo_edgeconfig->get_uploaderconfig( ).
        IF lo_uploaderconfig IS NOT INITIAL.
          lo_scheduleconfig = lo_uploaderconfig->get_scheduleconfig( ).
          IF lo_scheduleconfig IS NOT INITIAL.
            lv_scheduleexpression = lo_scheduleconfig->get_scheduleexpression( ).
            lv_durationinseconds = lo_scheduleconfig->get_durationinseconds( ).
          ENDIF.
        ENDIF.
        lo_deletionconfig = lo_edgeconfig->get_deletionconfig( ).
        IF lo_deletionconfig IS NOT INITIAL.
          lv_edgeretentioninhours = lo_deletionconfig->get_edgeretentioninhours( ).
          lo_localsizeconfig = lo_deletionconfig->get_localsizeconfig( ).
          IF lo_localsizeconfig IS NOT INITIAL.
            lv_maxlocalmediasizeinmb = lo_localsizeconfig->get_maxlocalmediasizeinmb( ).
            lv_strategyonfullsize = lo_localsizeconfig->get_strategyonfullsize( ).
          ENDIF.
          lv_deleteafterupload = lo_deletionconfig->get_deleteafterupload( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.