Struct aws_sdk_cloudwatch::client::fluent_builders::DescribeAlarms

pub struct DescribeAlarms<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to 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.

Implementations

impl<C, M, R> DescribeAlarms<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeAlarmsOutput, SdkError<DescribeAlarmsError>> where
    R::Policy: SmithyRetryPolicy<DescribeAlarmsInputOperationOutputAlias, DescribeAlarmsOutput, DescribeAlarmsError, DescribeAlarmsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn alarm_names(self, inp: impl Into<String>) -> Self

Appends an item to AlarmNames.

To override the contents of this collection use set_alarm_names.

The names of the alarms to retrieve information about.

pub fn set_alarm_names(self, input: Option<Vec<String>>) -> Self

The names of the alarms to retrieve information about.

pub fn alarm_name_prefix(self, inp: impl Into<String>) -> Self

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.

pub fn set_alarm_name_prefix(self, input: Option<String>) -> Self

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.

pub fn alarm_types(self, inp: impl Into<AlarmType>) -> Self

Appends an item to AlarmTypes.

To override the contents of this collection use set_alarm_types.

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.

pub fn set_alarm_types(self, input: Option<Vec<AlarmType>>) -> Self

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.

pub fn children_of_alarm_name(self, inp: impl Into<String>) -> Self

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.

pub fn set_children_of_alarm_name(self, input: Option<String>) -> Self

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.

pub fn parents_of_alarm_name(self, inp: impl Into<String>) -> Self

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.

pub fn set_parents_of_alarm_name(self, input: Option<String>) -> Self

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.

pub fn state_value(self, inp: StateValue) -> Self

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

pub fn set_state_value(self, input: Option<StateValue>) -> Self

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

pub fn action_prefix(self, inp: impl Into<String>) -> Self

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.

pub fn set_action_prefix(self, input: Option<String>) -> Self

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.

pub fn max_records(self, inp: i32) -> Self

The maximum number of alarm descriptions to retrieve.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of alarm descriptions to retrieve.

pub fn next_token(self, inp: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeAlarms<C, M, R>

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

Formats the value using the given formatter.