Struct rusoto_cloudwatch::DescribeAlarmsInput

pub struct DescribeAlarmsInput {
    pub action_prefix: Option<String>,
    pub alarm_name_prefix: Option<String>,
    pub alarm_names: Option<Vec<String>>,
    pub alarm_types: Option<Vec<String>>,
    pub children_of_alarm_name: Option<String>,
    pub max_records: Option<i64>,
    pub next_token: Option<String>,
    pub parents_of_alarm_name: Option<String>,
    pub state_value: Option<String>,
}

Fields

action_prefix: Option<String>

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.

alarm_name_prefix: Option<String>

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.

alarm_names: Option<Vec<String>>

The names of the alarms to retrieve information about.

alarm_types: Option<Vec<String>>

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.

children_of_alarm_name: Option<String>

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 will 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.

max_records: Option<i64>

The maximum number of alarm descriptions to retrieve.

next_token: Option<String>

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

parents_of_alarm_name: Option<String>

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 will 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.

state_value: Option<String>

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

Trait Implementations

impl Clone for DescribeAlarmsInput

pub fn clone(&self) -> DescribeAlarmsInput

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeAlarmsInput

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeAlarmsInput

pub fn default() -> DescribeAlarmsInput

Returns the "default value" for a type.

impl PartialEq<DescribeAlarmsInput> for DescribeAlarmsInput

pub fn eq(&self, other: &DescribeAlarmsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &DescribeAlarmsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeAlarmsInput