Skip to content

/AWS1/IF_CWT=>DESCRIBEALARMS()

About DescribeAlarms

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

Method Signature

METHODS /AWS1/IF_CWT~DESCRIBEALARMS
  IMPORTING
    !IT_ALARMNAMES TYPE /AWS1/CL_CWTALARMNAMES_W=>TT_ALARMNAMES OPTIONAL
    !IV_ALARMNAMEPREFIX TYPE /AWS1/CWTALARMNAMEPREFIX OPTIONAL
    !IT_ALARMTYPES TYPE /AWS1/CL_CWTALARMTYPES_W=>TT_ALARMTYPES OPTIONAL
    !IV_CHILDRENOFALARMNAME TYPE /AWS1/CWTALARMNAME OPTIONAL
    !IV_PARENTSOFALARMNAME TYPE /AWS1/CWTALARMNAME OPTIONAL
    !IV_STATEVALUE TYPE /AWS1/CWTSTATEVALUE OPTIONAL
    !IV_ACTIONPREFIX TYPE /AWS1/CWTACTIONPREFIX OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/CWTMAXRECORDS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWTNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwtdescralarmsoutput
  RAISING
    /AWS1/CX_CWTINVALIDNEXTTOKEN
    /AWS1/CX_CWTCLIENTEXC
    /AWS1/CX_CWTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_alarmnames TYPE /AWS1/CL_CWTALARMNAMES_W=>TT_ALARMNAMES TT_ALARMNAMES

The names of the alarms to retrieve information about.

iv_alarmnameprefix TYPE /AWS1/CWTALARMNAMEPREFIX /AWS1/CWTALARMNAMEPREFIX

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

If this parameter is specified, you cannot specify AlarmNames.

it_alarmtypes TYPE /AWS1/CL_CWTALARMTYPES_W=>TT_ALARMTYPES TT_ALARMTYPES

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.

For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

iv_childrenofalarmname TYPE /AWS1/CWTALARMNAME /AWS1/CWTALARMNAME

If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

iv_parentsofalarmname TYPE /AWS1/CWTALARMNAME /AWS1/CWTALARMNAME

If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

iv_statevalue TYPE /AWS1/CWTSTATEVALUE /AWS1/CWTSTATEVALUE

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

iv_actionprefix TYPE /AWS1/CWTACTIONPREFIX /AWS1/CWTACTIONPREFIX

Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

iv_maxrecords TYPE /AWS1/CWTMAXRECORDS /AWS1/CWTMAXRECORDS

The maximum number of alarm descriptions to retrieve.

iv_nexttoken TYPE /AWS1/CWTNEXTTOKEN /AWS1/CWTNEXTTOKEN

The token returned by a previous call to indicate that there is more data available.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwtdescralarmsoutput /AWS1/CL_CWTDESCRALARMSOUTPUT

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->describealarms(
  it_alarmnames = VALUE /aws1/cl_cwtalarmnames_w=>tt_alarmnames(
    ( new /aws1/cl_cwtalarmnames_w( |string| ) )
  )
  it_alarmtypes = VALUE /aws1/cl_cwtalarmtypes_w=>tt_alarmtypes(
    ( new /aws1/cl_cwtalarmtypes_w( |string| ) )
  )
  iv_actionprefix = |string|
  iv_alarmnameprefix = |string|
  iv_childrenofalarmname = |string|
  iv_maxrecords = 123
  iv_nexttoken = |string|
  iv_parentsofalarmname = |string|
  iv_statevalue = |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_compositealarms( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_actionsenabled = lo_row_1->get_actionsenabled( ).
      LOOP AT lo_row_1->get_alarmactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_alarmarn = lo_row_1->get_alarmarn( ).
      lv_timestamp = lo_row_1->get_alarmconfupdatedtsmp( ).
      lv_alarmdescription = lo_row_1->get_alarmdescription( ).
      lv_alarmname = lo_row_1->get_alarmname( ).
      lv_alarmrule = lo_row_1->get_alarmrule( ).
      LOOP AT lo_row_1->get_insufficientdataactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_okactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_statereason = lo_row_1->get_statereason( ).
      lv_statereasondata = lo_row_1->get_statereasondata( ).
      lv_timestamp = lo_row_1->get_stateupdatedtimestamp( ).
      lv_statevalue = lo_row_1->get_statevalue( ).
      lv_timestamp = lo_row_1->get_statetransedtimestamp( ).
      lv_actionssuppressedby = lo_row_1->get_actionssuppressedby( ).
      lv_actionssuppressedreason = lo_row_1->get_actionssuppressedreason( ).
      lv_alarmarn = lo_row_1->get_actionssuppressor( ).
      lv_suppressorperiod = lo_row_1->get_actionssuporwaitperiod( ).
      lv_suppressorperiod = lo_row_1->get_actssuporextensionperiod( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_metricalarms( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_alarmname = lo_row_5->get_alarmname( ).
      lv_alarmarn = lo_row_5->get_alarmarn( ).
      lv_alarmdescription = lo_row_5->get_alarmdescription( ).
      lv_timestamp = lo_row_5->get_alarmconfupdatedtsmp( ).
      lv_actionsenabled = lo_row_5->get_actionsenabled( ).
      LOOP AT lo_row_5->get_okactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_5->get_alarmactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_5->get_insufficientdataactions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcename = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_statevalue = lo_row_5->get_statevalue( ).
      lv_statereason = lo_row_5->get_statereason( ).
      lv_statereasondata = lo_row_5->get_statereasondata( ).
      lv_timestamp = lo_row_5->get_stateupdatedtimestamp( ).
      lv_metricname = lo_row_5->get_metricname( ).
      lv_namespace = lo_row_5->get_namespace( ).
      lv_statistic = lo_row_5->get_statistic( ).
      lv_extendedstatistic = lo_row_5->get_extendedstatistic( ).
      LOOP AT lo_row_5->get_dimensions( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_dimensionname = lo_row_7->get_name( ).
          lv_dimensionvalue = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_period = lo_row_5->get_period( ).
      lv_standardunit = lo_row_5->get_unit( ).
      lv_evaluationperiods = lo_row_5->get_evaluationperiods( ).
      lv_datapointstoalarm = lo_row_5->get_datapointstoalarm( ).
      lv_threshold = lo_row_5->get_threshold( ).
      lv_comparisonoperator = lo_row_5->get_comparisonoperator( ).
      lv_treatmissingdata = lo_row_5->get_treatmissingdata( ).
      lv_evaluatelowsamplecountp = lo_row_5->get_evaluatelowsamplectper00( ).
      LOOP AT lo_row_5->get_metrics( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_metricid = lo_row_9->get_id( ).
          lo_metricstat = lo_row_9->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_6.
                lo_row_7 = lo_row_6.
                IF lo_row_7 IS NOT INITIAL.
                  lv_dimensionname = lo_row_7->get_name( ).
                  lv_dimensionvalue = lo_row_7->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_9->get_expression( ).
          lv_metriclabel = lo_row_9->get_label( ).
          lv_returndata = lo_row_9->get_returndata( ).
          lv_period = lo_row_9->get_period( ).
          lv_accountid = lo_row_9->get_accountid( ).
        ENDIF.
      ENDLOOP.
      lv_metricid = lo_row_5->get_thresholdmetricid( ).
      lv_evaluationstate = lo_row_5->get_evaluationstate( ).
      lv_timestamp = lo_row_5->get_statetransedtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.