aws_sdk_cloudwatch/client/
describe_alarms_for_metric.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeAlarmsForMetric`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`metric_name(impl Into<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_metric_name):<br>required: **true**<br><p>The name of the metric.</p><br>
7    ///   - [`namespace(impl Into<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_namespace):<br>required: **true**<br><p>The namespace of the metric.</p><br>
8    ///   - [`statistic(Statistic)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::statistic) / [`set_statistic(Option<Statistic>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_statistic):<br>required: **false**<br><p>The statistic for the metric, other than percentiles. For percentile statistics, use <code>ExtendedStatistics</code>.</p><br>
9    ///   - [`extended_statistic(impl Into<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::extended_statistic) / [`set_extended_statistic(Option<String>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_extended_statistic):<br>required: **false**<br><p>The percentile statistic for the metric. Specify a value between p0.0 and p100.</p><br>
10    ///   - [`dimensions(Dimension)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::dimensions) / [`set_dimensions(Option<Vec::<Dimension>>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_dimensions):<br>required: **false**<br><p>The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.</p><br>
11    ///   - [`period(i32)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::period) / [`set_period(Option<i32>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_period):<br>required: **false**<br><p>The period, in seconds, over which the statistic is applied.</p><br>
12    ///   - [`unit(StandardUnit)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::unit) / [`set_unit(Option<StandardUnit>)`](crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::set_unit):<br>required: **false**<br><p>The unit for the metric.</p><br>
13    /// - On success, responds with [`DescribeAlarmsForMetricOutput`](crate::operation::describe_alarms_for_metric::DescribeAlarmsForMetricOutput) with field(s):
14    ///   - [`metric_alarms(Option<Vec::<MetricAlarm>>)`](crate::operation::describe_alarms_for_metric::DescribeAlarmsForMetricOutput::metric_alarms): <p>The information for each alarm with the specified metric.</p>
15    /// - On failure, responds with [`SdkError<DescribeAlarmsForMetricError>`](crate::operation::describe_alarms_for_metric::DescribeAlarmsForMetricError)
16    pub fn describe_alarms_for_metric(&self) -> crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder {
17        crate::operation::describe_alarms_for_metric::builders::DescribeAlarmsForMetricFluentBuilder::new(self.handle.clone())
18    }
19}