/AWS1/CL_IOT=>DESCRIBESECURITYPROFILE()

About DescribeSecurityProfile

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Method Signature

IMPORTING

Required arguments:

iv_securityprofilename TYPE /AWS1/IOTSECURITYPROFILENAME /AWS1/IOTSECURITYPROFILENAME

The name of the security profile whose information you want to get.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotdescrsecprofilersp /AWS1/CL_IOTDESCRSECPROFILERSP

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_iot~describesecurityprofile( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_securityprofilename = lo_result->get_securityprofilename( ).
  lv_securityprofilearn = lo_result->get_securityprofilearn( ).
  lv_securityprofiledescript = lo_result->get_securityprofiledesc( ).
  LOOP AT lo_result->get_behaviors( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_behaviorname = lo_row_1->get_name( ).
      lv_behaviormetric = lo_row_1->get_metric( ).
      lo_metricdimension = lo_row_1->get_metricdimension( ).
      IF lo_metricdimension IS NOT INITIAL.
        lv_dimensionname = lo_metricdimension->get_dimensionname( ).
        lv_dimensionvalueoperator = lo_metricdimension->get_operator( ).
      ENDIF.
      lo_behaviorcriteria = lo_row_1->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_row_1->get_suppressalerts( ).
      lv_exportmetric = lo_row_1->get_exportmetric( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_alerttargets( ) into ls_row_10.
    lv_key = ls_row_10-key.
    lo_value = ls_row_10-value.
    IF lo_value IS NOT INITIAL.
      lv_alerttargetarn = lo_value->get_alerttargetarn( ).
      lv_rolearn = lo_value->get_rolearn( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_addlmetricstoretain( ) into lo_row_11.
    lo_row_12 = lo_row_11.
    IF lo_row_12 IS NOT INITIAL.
      lv_behaviormetric = lo_row_12->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_addlmetricstoretainv2( ) into lo_row_13.
    lo_row_14 = lo_row_13.
    IF lo_row_14 IS NOT INITIAL.
      lv_behaviormetric = lo_row_14->get_metric( ).
      lo_metricdimension = lo_row_14->get_metricdimension( ).
      IF lo_metricdimension IS NOT INITIAL.
        lv_dimensionname = lo_metricdimension->get_dimensionname( ).
        lv_dimensionvalueoperator = lo_metricdimension->get_operator( ).
      ENDIF.
      lv_exportmetric = lo_row_14->get_exportmetric( ).
    ENDIF.
  ENDLOOP.
  lv_version = lo_result->get_version( ).
  lv_timestamp = lo_result->get_creationdate( ).
  lv_timestamp = lo_result->get_lastmodifieddate( ).
  lo_metricsexportconfig = lo_result->get_metricsexportconfig( ).
  IF lo_metricsexportconfig IS NOT INITIAL.
    lv_mqtttopic = lo_metricsexportconfig->get_mqtttopic( ).
    lv_rolearn = lo_metricsexportconfig->get_rolearn( ).
  ENDIF.
ENDIF.