/AWS1/CL_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¶
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
AlarmRulefield of the composite alarm that you specify inChildrenOfAlarmName. Information about the composite alarm that you name inChildrenOfAlarmNameis not returned.If you specify
ChildrenOfAlarmName, you cannot specify any other parameters in the request except forMaxRecordsandNextToken. If you do so, you receive a validation error.Only the
Alarm Name,ARN,StateValue(OK/ALARM/INSUFFICIENT_DATA), andStateUpdatedTimestampinformation are returned by this operation when you use this parameter. To get complete information about these alarms, perform anotherDescribeAlarmsoperation and specify the parent alarm names in theAlarmNamesparameter.
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
AlarmRuleparameters that reference the alarm named inParentsOfAlarmName. Information about the alarm that you specify inParentsOfAlarmNameis not returned.If you specify
ParentsOfAlarmName, you cannot specify any other parameters in the request except forMaxRecordsandNextToken. 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
DescribeAlarmsoperation and specify the parent alarm names in theAlarmNamesparameter.
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.