aws_sdk_medialive/client/
get_cloud_watch_alarm_template.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 [`GetCloudWatchAlarmTemplate`](crate::operation::get_cloud_watch_alarm_template::builders::GetCloudWatchAlarmTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::get_cloud_watch_alarm_template::builders::GetCloudWatchAlarmTemplateFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::builders::GetCloudWatchAlarmTemplateFluentBuilder::set_identifier):<br>required: **true**<br>A cloudwatch alarm template's identifier. Can be either be its id or current name.<br>
7    /// - On success, responds with [`GetCloudWatchAlarmTemplateOutput`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::arn): A cloudwatch alarm template's ARN (Amazon Resource Name)
9    ///   - [`comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::comparison_operator): The comparison operator used to compare the specified statistic and the threshold.
10    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::created_at): Placeholder documentation for __timestampIso8601
11    ///   - [`datapoints_to_alarm(Option<i32>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::datapoints_to_alarm): The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
12    ///   - [`description(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::description): A resource's optional description.
13    ///   - [`evaluation_periods(Option<i32>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::evaluation_periods): The number of periods over which data is compared to the specified threshold.
14    ///   - [`group_id(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::group_id): A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
15    ///   - [`id(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::id): A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
16    ///   - [`metric_name(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::metric_name): The name of the metric associated with the alarm. Must be compatible with targetResourceType.
17    ///   - [`modified_at(Option<DateTime>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::modified_at): Placeholder documentation for __timestampIso8601
18    ///   - [`name(Option<String>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::name): A resource's name. Names must be unique within the scope of a resource type in a specific region.
19    ///   - [`period(Option<i32>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::period): The period, in seconds, over which the specified statistic is applied.
20    ///   - [`statistic(Option<CloudWatchAlarmTemplateStatistic>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::statistic): The statistic to apply to the alarm's metric data.
21    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::tags): Represents the tags associated with a resource.
22    ///   - [`target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::target_resource_type): The resource type this template should dynamically generate cloudwatch metric alarms for.
23    ///   - [`threshold(Option<f64>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::threshold): The threshold value to compare with the specified statistic.
24    ///   - [`treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateOutput::treat_missing_data): Specifies how missing data points are treated when evaluating the alarm's condition.
25    /// - On failure, responds with [`SdkError<GetCloudWatchAlarmTemplateError>`](crate::operation::get_cloud_watch_alarm_template::GetCloudWatchAlarmTemplateError)
26    pub fn get_cloud_watch_alarm_template(
27        &self,
28    ) -> crate::operation::get_cloud_watch_alarm_template::builders::GetCloudWatchAlarmTemplateFluentBuilder {
29        crate::operation::get_cloud_watch_alarm_template::builders::GetCloudWatchAlarmTemplateFluentBuilder::new(self.handle.clone())
30    }
31}
aws_sdk_medialive/client/get_cloud_watch_alarm_template.rs

aws_sdk_medialive/client/
get_cloud_watch_alarm_template.rs
