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