/AWS1/IF_IOT=>LISTVIOLATIONEVENTS()

About ListViolationEvents

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

Requires permission to access the ListViolationEvents action.

Method Signature

METHODS /AWS1/IF_IOT~LISTVIOLATIONEVENTS
  IMPORTING
    !IV_STARTTIME TYPE /AWS1/IOTTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/IOTTIMESTAMP OPTIONAL
    !IV_THINGNAME TYPE /AWS1/IOTDEVDEFENDERTHINGNAME OPTIONAL
    !IV_SECURITYPROFILENAME TYPE /AWS1/IOTSECURITYPROFILENAME OPTIONAL
    !IV_BEHAVIORCRITERIATYPE TYPE /AWS1/IOTBEHAVIORCRITERIATYPE OPTIONAL
    !IV_LISTSUPPRESSEDALERTS TYPE /AWS1/IOTLISTSUPPRESSEDALERTS OPTIONAL
    !IV_VERIFICATIONSTATE TYPE /AWS1/IOTVERIFICATIONSTATE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOTMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotlistvioeventsrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_starttime TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

The start time for the alerts to be listed.

iv_endtime TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

The end time for the alerts to be listed.

Optional arguments:

iv_thingname TYPE /AWS1/IOTDEVDEFENDERTHINGNAME /AWS1/IOTDEVDEFENDERTHINGNAME

A filter to limit results to those alerts caused by the specified thing.

iv_securityprofilename TYPE /AWS1/IOTSECURITYPROFILENAME /AWS1/IOTSECURITYPROFILENAME

A filter to limit results to those alerts generated by the specified security profile.

iv_behaviorcriteriatype TYPE /AWS1/IOTBEHAVIORCRITERIATYPE /AWS1/IOTBEHAVIORCRITERIATYPE

The criteria for a behavior.

iv_listsuppressedalerts TYPE /AWS1/IOTLISTSUPPRESSEDALERTS /AWS1/IOTLISTSUPPRESSEDALERTS

A list of all suppressed alerts.

iv_verificationstate TYPE /AWS1/IOTVERIFICATIONSTATE /AWS1/IOTVERIFICATIONSTATE

The verification state of the violation (detect alarm).

iv_nexttoken TYPE /AWS1/IOTNEXTTOKEN /AWS1/IOTNEXTTOKEN

The token for the next set of results.

iv_maxresults TYPE /AWS1/IOTMAXRESULTS /AWS1/IOTMAXRESULTS

The maximum number of results to return at one time.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotlistvioeventsrsp /AWS1/CL_IOTLISTVIOEVENTSRSP

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->listviolationevents(
  iv_behaviorcriteriatype = |string|
  iv_endtime = '20150101000000.0000000'
  iv_listsuppressedalerts = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_securityprofilename = |string|
  iv_starttime = '20150101000000.0000000'
  iv_thingname = |string|
  iv_verificationstate = |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_violationevents( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_violationid = lo_row_1->get_violationid( ).
      lv_devicedefenderthingname = lo_row_1->get_thingname( ).
      lv_securityprofilename = lo_row_1->get_securityprofilename( ).
      lo_behavior = lo_row_1->get_behavior( ).
      IF lo_behavior IS NOT INITIAL.
        lv_behaviorname = lo_behavior->get_name( ).
        lv_behaviormetric = lo_behavior->get_metric( ).
        lo_metricdimension = lo_behavior->get_metricdimension( ).
        IF lo_metricdimension IS NOT INITIAL.
          lv_dimensionname = lo_metricdimension->get_dimensionname( ).
          lv_dimensionvalueoperator = lo_metricdimension->get_operator( ).
        ENDIF.
        lo_behaviorcriteria = lo_behavior->get_criteria( ).
        IF lo_behaviorcriteria IS NOT INITIAL.
          lv_comparisonoperator = lo_behaviorcriteria->get_comparisonoperator( ).
          lo_metricvalue = lo_behaviorcriteria->get_value( ).
          IF lo_metricvalue IS NOT INITIAL.
            lv_unsignedlong = lo_metricvalue->get_count( ).
            LOOP AT lo_metricvalue->get_cidrs( ) into lo_row_2.
              lo_row_3 = lo_row_2.
              IF lo_row_3 IS NOT INITIAL.
                lv_cidr = lo_row_3->get_value( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_metricvalue->get_ports( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                lv_port = lo_row_5->get_value( ).
              ENDIF.
            ENDLOOP.
            lv_number = lo_metricvalue->get_number( ).
            LOOP AT lo_metricvalue->get_numbers( ) into lo_row_6.
              lo_row_7 = lo_row_6.
              IF lo_row_7 IS NOT INITIAL.
                lv_number = lo_row_7->get_value( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_metricvalue->get_strings( ) into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_stringvalue = lo_row_9->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
          lv_durationseconds = lo_behaviorcriteria->get_durationseconds( ).
          lv_consecutivedatapointsto = lo_behaviorcriteria->get_conseqdatapointstoalarm( ).
          lv_consecutivedatapointsto_1 = lo_behaviorcriteria->get_conseqdatapointstoclear( ).
          lo_statisticalthreshold = lo_behaviorcriteria->get_statisticalthreshold( ).
          IF lo_statisticalthreshold IS NOT INITIAL.
            lv_evaluationstatistic = lo_statisticalthreshold->get_statistic( ).
          ENDIF.
          lo_machinelearningdetectio = lo_behaviorcriteria->get_mldetectionconfig( ).
          IF lo_machinelearningdetectio IS NOT INITIAL.
            lv_confidencelevel = lo_machinelearningdetectio->get_confidencelevel( ).
          ENDIF.
        ENDIF.
        lv_suppressalerts = lo_behavior->get_suppressalerts( ).
        lv_exportmetric = lo_behavior->get_exportmetric( ).
      ENDIF.
      lo_metricvalue = lo_row_1->get_metricvalue( ).
      IF lo_metricvalue IS NOT INITIAL.
        lv_unsignedlong = lo_metricvalue->get_count( ).
        LOOP AT lo_metricvalue->get_cidrs( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_cidr = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_metricvalue->get_ports( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_port = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_number = lo_metricvalue->get_number( ).
        LOOP AT lo_metricvalue->get_numbers( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_number = lo_row_7->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_metricvalue->get_strings( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_stringvalue = lo_row_9->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_violationeventadditiona = lo_row_1->get_violationeventaddlinfo( ).
      IF lo_violationeventadditiona IS NOT INITIAL.
        lv_confidencelevel = lo_violationeventadditiona->get_confidencelevel( ).
      ENDIF.
      lv_violationeventtype = lo_row_1->get_violationeventtype( ).
      lv_verificationstate = lo_row_1->get_verificationstate( ).
      lv_verificationstatedescri = lo_row_1->get_verificationstatedesc( ).
      lv_timestamp = lo_row_1->get_violationeventtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.