LISTMONITOREVALUATIONS()`¶

About ListMonitorEvaluations¶

Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

Method Signature¶

METHODS /AWS1/IF_FCS~LISTMONITOREVALUATIONS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/FCSNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FCSMAXRESULTS OPTIONAL
    !IV_MONITORARN TYPE /AWS1/FCSARN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_FCSFILTER=>TT_FILTERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fcslistmonievalsrsp
  RAISING
    /AWS1/CX_FCSINVALIDINPUTEX
    /AWS1/CX_FCSINVALIDNEXTTOKENEX
    /AWS1/CX_FCSRESOURCENOTFOUNDEX
    /AWS1/CX_FCSCLIENTEXC
    /AWS1/CX_FCSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_monitorarn` `TYPE /AWS1/FCSARN` `/AWS1/FCSARN`¶

The Amazon Resource Name (ARN) of the monitor resource to get results from.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/FCSNEXTTOKEN` `/AWS1/FCSNEXTTOKEN`¶

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

`iv_maxresults` `TYPE /AWS1/FCSMAXRESULTS` `/AWS1/FCSMAXRESULTS`¶

The maximum number of monitoring results to return.

`it_filters` `TYPE /AWS1/CL_FCSFILTER=>TT_FILTERS` `TT_FILTERS`¶

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

Condition - The condition to apply. Valid values are IS and IS_NOT.

Key - The name of the parameter to filter on. The only valid value is EvaluationState.

Value - The value to match. Valid values are only SUCCESS or FAILURE.

For example, to list only successful monitor evaluations, you would specify:

"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fcslistmonievalsrsp` `/AWS1/CL_FCSLISTMONIEVALSRSP`¶

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->listmonitorevaluations(
  it_filters = VALUE /aws1/cl_fcsfilter=>tt_filters(
    (
      new /aws1/cl_fcsfilter(
        iv_condition = |string|
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_monitorarn = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_predictormonitorevals( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_resourcearn( ).
      lv_arn = lo_row_1->get_monitorarn( ).
      lv_timestamp = lo_row_1->get_evaluationtime( ).
      lv_evaluationstate = lo_row_1->get_evaluationstate( ).
      lv_timestamp = lo_row_1->get_windowstartdatetime( ).
      lv_timestamp = lo_row_1->get_windowenddatetime( ).
      lo_predictorevent = lo_row_1->get_predictorevent( ).
      IF lo_predictorevent IS NOT INITIAL.
        lv_detail = lo_predictorevent->get_detail( ).
        lv_timestamp = lo_predictorevent->get_datetime( ).
      ENDIF.
      lo_monitordatasource = lo_row_1->get_monitordatasource( ).
      IF lo_monitordatasource IS NOT INITIAL.
        lv_arn = lo_monitordatasource->get_datasetimportjobarn( ).
        lv_arn = lo_monitordatasource->get_forecastarn( ).
        lv_arn = lo_monitordatasource->get_predictorarn( ).
      ENDIF.
      LOOP AT lo_row_1->get_metricresults( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_metricname = lo_row_3->get_metricname( ).
          lv_double = lo_row_3->get_metricvalue( ).
        ENDIF.
      ENDLOOP.
      lv_long = lo_row_1->get_numitemsevaluated( ).
      lv_message = lo_row_1->get_message( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_FCS=>LISTMONITOREVALUATIONS()¶