Skip to content

/AWS1/IF_CWT=>DESCRIBEANOMALYDETECTORS()

About DescribeAnomalyDetectors

Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

Method Signature

METHODS /AWS1/IF_CWT~DESCRIBEANOMALYDETECTORS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/CWTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CWTMAXRETDRESULTSCOUNT OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/CWTNAMESPACE OPTIONAL
    !IV_METRICNAME TYPE /AWS1/CWTMETRICNAME OPTIONAL
    !IT_DIMENSIONS TYPE /AWS1/CL_CWTDIMENSION=>TT_DIMENSIONS OPTIONAL
    !IT_ANOMALYDETECTORTYPES TYPE /AWS1/CL_CWTANOMALYDETECTORT00=>TT_ANOMALYDETECTORTYPES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwtdscanomalydetect01
  RAISING
    /AWS1/CX_CWTINTERNALSVCFAULT
    /AWS1/CX_CWTINVALIDNEXTTOKEN
    /AWS1/CX_CWTINVPRMCOMBINATIO00
    /AWS1/CX_CWTINVPARAMVALUEEX
    /AWS1/CX_CWTCLIENTEXC
    /AWS1/CX_CWTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/CWTNEXTTOKEN /AWS1/CWTNEXTTOKEN

Use the token returned by the previous operation to request the next page of results.

iv_maxresults TYPE /AWS1/CWTMAXRETDRESULTSCOUNT /AWS1/CWTMAXRETDRESULTSCOUNT

The maximum number of results to return in one operation. The maximum value that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

iv_namespace TYPE /AWS1/CWTNAMESPACE /AWS1/CWTNAMESPACE

Limits the results to only the anomaly detection models that are associated with the specified namespace.

iv_metricname TYPE /AWS1/CWTMETRICNAME /AWS1/CWTMETRICNAME

Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.

it_dimensions TYPE /AWS1/CL_CWTDIMENSION=>TT_DIMENSIONS TT_DIMENSIONS

Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.

it_anomalydetectortypes TYPE /AWS1/CL_CWTANOMALYDETECTORT00=>TT_ANOMALYDETECTORTYPES TT_ANOMALYDETECTORTYPES

The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwtdscanomalydetect01 /AWS1/CL_CWTDSCANOMALYDETECT01

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->describeanomalydetectors(
  it_anomalydetectortypes = VALUE /aws1/cl_cwtanomalydetectort00=>tt_anomalydetectortypes(
    ( new /aws1/cl_cwtanomalydetectort00( |string| ) )
  )
  it_dimensions = VALUE /aws1/cl_cwtdimension=>tt_dimensions(
    (
      new /aws1/cl_cwtdimension(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_metricname = |string|
  iv_namespace = |string|
  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_anomalydetectors( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_namespace = lo_row_1->get_namespace( ).
      lv_metricname = lo_row_1->get_metricname( ).
      LOOP AT lo_row_1->get_dimensions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_dimensionname = lo_row_3->get_name( ).
          lv_dimensionvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_anomalydetectormetricst = lo_row_1->get_stat( ).
      lo_anomalydetectorconfigur = lo_row_1->get_configuration( ).
      IF lo_anomalydetectorconfigur IS NOT INITIAL.
        LOOP AT lo_anomalydetectorconfigur->get_excludedtimeranges( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_timestamp = lo_row_5->get_starttime( ).
            lv_timestamp = lo_row_5->get_endtime( ).
          ENDIF.
        ENDLOOP.
        lv_anomalydetectormetricti = lo_anomalydetectorconfigur->get_metrictimezone( ).
      ENDIF.
      lv_anomalydetectorstateval = lo_row_1->get_statevalue( ).
      lo_metriccharacteristics = lo_row_1->get_metriccharacteristics( ).
      IF lo_metriccharacteristics IS NOT INITIAL.
        lv_periodicspikes = lo_metriccharacteristics->get_periodicspikes( ).
      ENDIF.
      lo_singlemetricanomalydete = lo_row_1->get_singlemetricanomalydet00( ).
      IF lo_singlemetricanomalydete IS NOT INITIAL.
        lv_accountid = lo_singlemetricanomalydete->get_accountid( ).
        lv_namespace = lo_singlemetricanomalydete->get_namespace( ).
        lv_metricname = lo_singlemetricanomalydete->get_metricname( ).
        LOOP AT lo_singlemetricanomalydete->get_dimensions( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_dimensionname = lo_row_3->get_name( ).
            lv_dimensionvalue = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_anomalydetectormetricst = lo_singlemetricanomalydete->get_stat( ).
      ENDIF.
      lo_metricmathanomalydetect = lo_row_1->get_metricmathanomalydetec00( ).
      IF lo_metricmathanomalydetect IS NOT INITIAL.
        LOOP AT lo_metricmathanomalydetect->get_metricdataqueries( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_metricid = lo_row_7->get_id( ).
            lo_metricstat = lo_row_7->get_metricstat( ).
            IF lo_metricstat IS NOT INITIAL.
              lo_metric = lo_metricstat->get_metric( ).
              IF lo_metric IS NOT INITIAL.
                lv_namespace = lo_metric->get_namespace( ).
                lv_metricname = lo_metric->get_metricname( ).
                LOOP AT lo_metric->get_dimensions( ) into lo_row_2.
                  lo_row_3 = lo_row_2.
                  IF lo_row_3 IS NOT INITIAL.
                    lv_dimensionname = lo_row_3->get_name( ).
                    lv_dimensionvalue = lo_row_3->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lv_period = lo_metricstat->get_period( ).
              lv_stat = lo_metricstat->get_stat( ).
              lv_standardunit = lo_metricstat->get_unit( ).
            ENDIF.
            lv_metricexpression = lo_row_7->get_expression( ).
            lv_metriclabel = lo_row_7->get_label( ).
            lv_returndata = lo_row_7->get_returndata( ).
            lv_period = lo_row_7->get_period( ).
            lv_accountid = lo_row_7->get_accountid( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.