Skip to content

/AWS1/IF_IOT=>DESCRIBEDETECTMIGACTIONSTASK()

About DescribeDetectMitigationActionsTask

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Method Signature

METHODS /AWS1/IF_IOT~DESCRIBEDETECTMIGACTIONSTASK
  IMPORTING
    !IV_TASKID TYPE /AWS1/IOTMIGACTIONSTASKID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotdscdetectmigactt01
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_taskid TYPE /AWS1/IOTMIGACTIONSTASKID /AWS1/IOTMIGACTIONSTASKID

The unique identifier of the task.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotdscdetectmigactt01 /AWS1/CL_IOTDSCDETECTMIGACTT01

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->describedetectmigactionstask( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_detectmitigationactions = lo_result->get_tasksummary( ).
  IF lo_detectmitigationactions IS NOT INITIAL.
    lv_mitigationactionstaskid = lo_detectmitigationactions->get_taskid( ).
    lv_detectmitigationactions_1 = lo_detectmitigationactions->get_taskstatus( ).
    lv_timestamp = lo_detectmitigationactions->get_taskstarttime( ).
    lv_timestamp = lo_detectmitigationactions->get_taskendtime( ).
    lo_detectmitigationactions_2 = lo_detectmitigationactions->get_target( ).
    IF lo_detectmitigationactions_2 IS NOT INITIAL.
      LOOP AT lo_detectmitigationactions_2->get_violationids( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_violationid = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_securityprofilename = lo_detectmitigationactions_2->get_securityprofilename( ).
      lv_behaviorname = lo_detectmitigationactions_2->get_behaviorname( ).
    ENDIF.
    lo_violationeventoccurrenc = lo_detectmitigationactions->get_vioeventoccurrencerange( ).
    IF lo_violationeventoccurrenc IS NOT INITIAL.
      lv_timestamp = lo_violationeventoccurrenc->get_starttime( ).
      lv_timestamp = lo_violationeventoccurrenc->get_endtime( ).
    ENDIF.
    lv_primitiveboolean = lo_detectmitigationactions->get_onlyactiveviosincluded( ).
    lv_primitiveboolean = lo_detectmitigationactions->get_suppressedalertsincluded( ).
    LOOP AT lo_detectmitigationactions->get_actionsdefinition( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_mitigationactionname = lo_row_3->get_name( ).
        lv_mitigationactionid = lo_row_3->get_id( ).
        lv_rolearn = lo_row_3->get_rolearn( ).
        lo_mitigationactionparams = lo_row_3->get_actionparams( ).
        IF lo_mitigationactionparams IS NOT INITIAL.
          lo_updatedevicecertificate = lo_mitigationactionparams->get_updatedevicecertparams( ).
          IF lo_updatedevicecertificate IS NOT INITIAL.
            lv_devicecertificateupdate = lo_updatedevicecertificate->get_action( ).
          ENDIF.
          lo_updatecacertificatepara = lo_mitigationactionparams->get_updatecacertparams( ).
          IF lo_updatecacertificatepara IS NOT INITIAL.
            lv_cacertificateupdateacti = lo_updatecacertificatepara->get_action( ).
          ENDIF.
          lo_addthingstothinggrouppa = lo_mitigationactionparams->get_addthgstothggroupparams( ).
          IF lo_addthingstothinggrouppa IS NOT INITIAL.
            LOOP AT lo_addthingstothinggrouppa->get_thinggroupnames( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                lv_thinggroupname = lo_row_5->get_value( ).
              ENDIF.
            ENDLOOP.
            lv_nullableboolean = lo_addthingstothinggrouppa->get_overridedynamicgroups( ).
          ENDIF.
          lo_replacedefaultpolicyver = lo_mitigationactionparams->get_rpldefpolicyvrsparams( ).
          IF lo_replacedefaultpolicyver IS NOT INITIAL.
            lv_policytemplatename = lo_replacedefaultpolicyver->get_templatename( ).
          ENDIF.
          lo_enableiotloggingparams = lo_mitigationactionparams->get_enableiotloggingparams( ).
          IF lo_enableiotloggingparams IS NOT INITIAL.
            lv_rolearn = lo_enableiotloggingparams->get_rolearnforlogging( ).
            lv_loglevel = lo_enableiotloggingparams->get_loglevel( ).
          ENDIF.
          lo_publishfindingtosnspara = lo_mitigationactionparams->get_publishfndgtosnsparams( ).
          IF lo_publishfindingtosnspara IS NOT INITIAL.
            lv_snstopicarn = lo_publishfindingtosnspara->get_topicarn( ).
          ENDIF.
        ENDIF.
      ENDIF.
    ENDLOOP.
    lo_detectmitigationactions_3 = lo_detectmitigationactions->get_taskstatistics( ).
    IF lo_detectmitigationactions_3 IS NOT INITIAL.
      lv_genericlongvalue = lo_detectmitigationactions_3->get_actionsexecuted( ).
      lv_genericlongvalue = lo_detectmitigationactions_3->get_actionsskipped( ).
      lv_genericlongvalue = lo_detectmitigationactions_3->get_actionsfailed( ).
    ENDIF.
  ENDIF.
ENDIF.