1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
///
/// Fluent builder for the `composite_alarm_exists` waiter.
///
/// This builder is intended to be used similar to the other fluent builders for
/// normal operations on the client. However, instead of a `send` method, it has
/// a `wait` method that takes a maximum amount of time to wait.
///
/// Construct this fluent builder using the client by importing the
/// [`Waiters`](crate::client::Waiters) trait and calling the methods
/// prefixed with `wait_until`.
///
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CompositeAlarmExistsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_alarms::builders::DescribeAlarmsInputBuilder,
}
impl CompositeAlarmExistsFluentBuilder {
/// Creates a new `CompositeAlarmExistsFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
/// Access the DescribeAlarms as a reference.
pub fn as_input(&self) -> &crate::operation::describe_alarms::builders::DescribeAlarmsInputBuilder {
&self.inner
}
/// Wait for `composite_alarm_exists`
pub async fn wait(
self,
max_wait: ::std::time::Duration,
) -> ::std::result::Result<
crate::waiters::composite_alarm_exists::CompositeAlarmExistsFinalPoll,
crate::waiters::composite_alarm_exists::WaitUntilCompositeAlarmExistsError,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
let runtime_plugins = crate::operation::describe_alarms::DescribeAlarms::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
::std::option::Option::None,
)
.with_operation_plugin(crate::sdk_feature_tracker::waiter::WaiterFeatureTrackerRuntimePlugin::new());
let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
let runtime_components_builder = runtime_plugins
.apply_client_configuration(&mut cfg)
.map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
let time_components = runtime_components_builder.into_time_components();
let sleep_impl = time_components.sleep_impl().expect("a sleep impl is required by waiters");
let time_source = time_components.time_source().expect("a time source is required by waiters");
let acceptor = move |result: ::std::result::Result<
&crate::operation::describe_alarms::DescribeAlarmsOutput,
&crate::operation::describe_alarms::DescribeAlarmsError,
>| {
// Matches: {"output":{"path":"length(CompositeAlarms[]) > `0`","expected":"true","comparator":"booleanEquals"}}
if crate::waiters::matchers::match_describe_alarms_5e47a4f72e6ce4350(result) {
return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
}
::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
};
let operation = move || {
let input = input.clone();
let runtime_plugins = runtime_plugins.clone();
async move { crate::operation::describe_alarms::DescribeAlarms::orchestrate(&runtime_plugins, input).await }
};
let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
.min_delay(::std::time::Duration::from_secs(5))
.max_delay(::std::time::Duration::from_secs(120))
.max_wait(max_wait)
.time_source(time_source)
.sleep_impl(sleep_impl)
.acceptor(acceptor)
.operation(operation)
.build();
::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
}
///
/// Appends an item to `AlarmNames`.
///
/// To override the contents of this collection use [`set_alarm_names`](Self::set_alarm_names).
///
/// <p>The names of the alarms to retrieve information about.</p>
pub fn alarm_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.alarm_names(input.into());
self
}
/// <p>The names of the alarms to retrieve information about.</p>
pub fn set_alarm_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_alarm_names(input);
self
}
/// <p>The names of the alarms to retrieve information about.</p>
pub fn get_alarm_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_alarm_names()
}
/// <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.</p>
/// <p>If this parameter is specified, you cannot specify <code>AlarmNames</code>.</p>
pub fn alarm_name_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.alarm_name_prefix(input.into());
self
}
/// <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.</p>
/// <p>If this parameter is specified, you cannot specify <code>AlarmNames</code>.</p>
pub fn set_alarm_name_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_alarm_name_prefix(input);
self
}
/// <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.</p>
/// <p>If this parameter is specified, you cannot specify <code>AlarmNames</code>.</p>
pub fn get_alarm_name_prefix(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_alarm_name_prefix()
}
///
/// Appends an item to `AlarmTypes`.
///
/// To override the contents of this collection use [`set_alarm_types`](Self::set_alarm_types).
///
/// <p>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, even if composite alarms exist in the account.</p>
/// <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.</p>
/// <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of composite alarms, and does not return any metric alarms.</p>
pub fn alarm_types(mut self, input: crate::types::AlarmType) -> Self {
self.inner = self.inner.alarm_types(input);
self
}
/// <p>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, even if composite alarms exist in the account.</p>
/// <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.</p>
/// <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of composite alarms, and does not return any metric alarms.</p>
pub fn set_alarm_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AlarmType>>) -> Self {
self.inner = self.inner.set_alarm_types(input);
self
}
/// <p>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, even if composite alarms exist in the account.</p>
/// <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.</p>
/// <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of composite alarms, and does not return any metric alarms.</p>
pub fn get_alarm_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AlarmType>> {
self.inner.get_alarm_types()
}
/// <p>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 <code>AlarmRule</code> field of the composite alarm that you specify in <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you name in <code>ChildrenOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code> (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn children_of_alarm_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.children_of_alarm_name(input.into());
self
}
/// <p>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 <code>AlarmRule</code> field of the composite alarm that you specify in <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you name in <code>ChildrenOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code> (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn set_children_of_alarm_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_children_of_alarm_name(input);
self
}
/// <p>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 <code>AlarmRule</code> field of the composite alarm that you specify in <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you name in <code>ChildrenOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code> (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn get_children_of_alarm_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_children_of_alarm_name()
}
/// <p>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 <code>AlarmRule</code> parameters that reference the alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you specify in <code>ParentsOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>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 <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn parents_of_alarm_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.parents_of_alarm_name(input.into());
self
}
/// <p>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 <code>AlarmRule</code> parameters that reference the alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you specify in <code>ParentsOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>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 <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn set_parents_of_alarm_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_parents_of_alarm_name(input);
self
}
/// <p>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 <code>AlarmRule</code> parameters that reference the alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you specify in <code>ParentsOfAlarmName</code> is not returned.</p>
/// <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation error.</p><note>
/// <p>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 <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
/// </note>
pub fn get_parents_of_alarm_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_parents_of_alarm_name()
}
/// <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
pub fn state_value(mut self, input: crate::types::StateValue) -> Self {
self.inner = self.inner.state_value(input);
self
}
/// <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
pub fn set_state_value(mut self, input: ::std::option::Option<crate::types::StateValue>) -> Self {
self.inner = self.inner.set_state_value(input);
self
}
/// <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
pub fn get_state_value(&self) -> &::std::option::Option<crate::types::StateValue> {
self.inner.get_state_value()
}
/// <p>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.</p>
pub fn action_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.action_prefix(input.into());
self
}
/// <p>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.</p>
pub fn set_action_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_action_prefix(input);
self
}
/// <p>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.</p>
pub fn get_action_prefix(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_action_prefix()
}
/// <p>The maximum number of alarm descriptions to retrieve.</p>
pub fn max_records(mut self, input: i32) -> Self {
self.inner = self.inner.max_records(input);
self
}
/// <p>The maximum number of alarm descriptions to retrieve.</p>
pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_records(input);
self
}
/// <p>The maximum number of alarm descriptions to retrieve.</p>
pub fn get_max_records(&self) -> &::std::option::Option<i32> {
self.inner.get_max_records()
}
/// <p>The token returned by a previous call to indicate that there is more data available.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The token returned by a previous call to indicate that there is more data available.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The token returned by a previous call to indicate that there is more data available.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
}
/// Successful return type for the `composite_alarm_exists` waiter.
pub type CompositeAlarmExistsFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
crate::operation::describe_alarms::DescribeAlarmsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_alarms::DescribeAlarmsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
>;
/// Error type for the `composite_alarm_exists` waiter.
pub type WaitUntilCompositeAlarmExistsError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
crate::operation::describe_alarms::DescribeAlarmsOutput,
crate::operation::describe_alarms::DescribeAlarmsError,
>;