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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
///
/// Fluent builder for the `snapshot_completed` 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 SnapshotCompletedFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_snapshots::builders::DescribeSnapshotsInputBuilder,
}
impl SnapshotCompletedFluentBuilder {
/// Creates a new `SnapshotCompletedFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
/// Access the DescribeSnapshots as a reference.
pub fn as_input(&self) -> &crate::operation::describe_snapshots::builders::DescribeSnapshotsInputBuilder {
&self.inner
}
/// Wait for `snapshot_completed`
pub async fn wait(
self,
max_wait: ::std::time::Duration,
) -> ::std::result::Result<
crate::waiters::snapshot_completed::SnapshotCompletedFinalPoll,
crate::waiters::snapshot_completed::WaitUntilSnapshotCompletedError,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
let runtime_plugins = crate::operation::describe_snapshots::DescribeSnapshots::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_snapshots::DescribeSnapshotsOutput,
&crate::operation::describe_snapshots::DescribeSnapshotsError,
>| {
// Matches: {"output":{"path":"Snapshots[].State","expected":"completed","comparator":"allStringEquals"}}
if crate::waiters::matchers::match_describe_snapshots_a0b4c167203a8805f(result) {
return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
}
// Matches: {"output":{"path":"Snapshots[].State","expected":"error","comparator":"anyStringEquals"}}
if crate::waiters::matchers::match_describe_snapshots_8bfc549023d126af0(result) {
return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
}
::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_snapshots::DescribeSnapshots::orchestrate(&runtime_plugins, input).await }
};
let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
.min_delay(::std::time::Duration::from_secs(15))
.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
}
/// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
/// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</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 from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</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 from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
///
/// Appends an item to `OwnerIds`.
///
/// To override the contents of this collection use [`set_owner_ids`](Self::set_owner_ids).
///
/// <p>Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, and <code>amazon</code>.</p>
pub fn owner_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.owner_ids(input.into());
self
}
/// <p>Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, and <code>amazon</code>.</p>
pub fn set_owner_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_owner_ids(input);
self
}
/// <p>Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, and <code>amazon</code>.</p>
pub fn get_owner_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_owner_ids()
}
///
/// Appends an item to `RestorableByUserIds`.
///
/// To override the contents of this collection use [`set_restorable_by_user_ids`](Self::set_restorable_by_user_ids).
///
/// <p>The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.</p>
pub fn restorable_by_user_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.restorable_by_user_ids(input.into());
self
}
/// <p>The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.</p>
pub fn set_restorable_by_user_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_restorable_by_user_ids(input);
self
}
/// <p>The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.</p>
pub fn get_restorable_by_user_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_restorable_by_user_ids()
}
///
/// Appends an item to `SnapshotIds`.
///
/// To override the contents of this collection use [`set_snapshot_ids`](Self::set_snapshot_ids).
///
/// <p>The snapshot IDs.</p>
/// <p>Default: Describes the snapshots for which you have create volume permissions.</p>
pub fn snapshot_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.snapshot_ids(input.into());
self
}
/// <p>The snapshot IDs.</p>
/// <p>Default: Describes the snapshots for which you have create volume permissions.</p>
pub fn set_snapshot_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_snapshot_ids(input);
self
}
/// <p>The snapshot IDs.</p>
/// <p>Default: Describes the snapshots for which you have create volume permissions.</p>
pub fn get_snapshot_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_snapshot_ids()
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.inner = self.inner.dry_run(input);
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_dry_run(input);
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
self.inner.get_dry_run()
}
///
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>description</code> - A description of the snapshot.</p></li>
/// <li>
/// <p><code>encrypted</code> - Indicates whether the snapshot is encrypted (<code>true</code> | <code>false</code>)</p></li>
/// <li>
/// <p><code>owner-alias</code> - The owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</p></li>
/// <li>
/// <p><code>snapshot-id</code> - The snapshot ID.</p></li>
/// <li>
/// <p><code>start-time</code> - The time stamp when the snapshot was initiated.</p></li>
/// <li>
/// <p><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</p></li>
/// <li>
/// <p><code>storage-tier</code> - The storage tier of the snapshot (<code>archive</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>transfer-type</code> - The type of operation used to create the snapshot (<code>time-based</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>tag</code>:<key>
/// - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
/// <code>Owner</code> and the value
/// <code>TeamA</code>, specify
/// <code>tag:Owner</code> for the filter name and
/// <code>TeamA</code> for the filter value.
/// </key></p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>volume-id</code> - The ID of the volume the snapshot is for.</p></li>
/// <li>
/// <p><code>volume-size</code> - The size of the volume, in GiB.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>description</code> - A description of the snapshot.</p></li>
/// <li>
/// <p><code>encrypted</code> - Indicates whether the snapshot is encrypted (<code>true</code> | <code>false</code>)</p></li>
/// <li>
/// <p><code>owner-alias</code> - The owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</p></li>
/// <li>
/// <p><code>snapshot-id</code> - The snapshot ID.</p></li>
/// <li>
/// <p><code>start-time</code> - The time stamp when the snapshot was initiated.</p></li>
/// <li>
/// <p><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</p></li>
/// <li>
/// <p><code>storage-tier</code> - The storage tier of the snapshot (<code>archive</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>transfer-type</code> - The type of operation used to create the snapshot (<code>time-based</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>tag</code>:<key>
/// - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
/// <code>Owner</code> and the value
/// <code>TeamA</code>, specify
/// <code>tag:Owner</code> for the filter name and
/// <code>TeamA</code> for the filter value.
/// </key></p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>volume-id</code> - The ID of the volume the snapshot is for.</p></li>
/// <li>
/// <p><code>volume-size</code> - The size of the volume, in GiB.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>description</code> - A description of the snapshot.</p></li>
/// <li>
/// <p><code>encrypted</code> - Indicates whether the snapshot is encrypted (<code>true</code> | <code>false</code>)</p></li>
/// <li>
/// <p><code>owner-alias</code> - The owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.</p></li>
/// <li>
/// <p><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</p></li>
/// <li>
/// <p><code>snapshot-id</code> - The snapshot ID.</p></li>
/// <li>
/// <p><code>start-time</code> - The time stamp when the snapshot was initiated.</p></li>
/// <li>
/// <p><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</p></li>
/// <li>
/// <p><code>storage-tier</code> - The storage tier of the snapshot (<code>archive</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>transfer-type</code> - The type of operation used to create the snapshot (<code>time-based</code> | <code>standard</code>).</p></li>
/// <li>
/// <p><code>tag</code>:<key>
/// - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
/// <code>Owner</code> and the value
/// <code>TeamA</code>, specify
/// <code>tag:Owner</code> for the filter name and
/// <code>TeamA</code> for the filter value.
/// </key></p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>volume-id</code> - The ID of the volume the snapshot is for.</p></li>
/// <li>
/// <p><code>volume-size</code> - The size of the volume, in GiB.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
self.inner.get_filters()
}
}
/// Successful return type for the `snapshot_completed` waiter.
pub type SnapshotCompletedFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
crate::operation::describe_snapshots::DescribeSnapshotsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_snapshots::DescribeSnapshotsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
>;
/// Error type for the `snapshot_completed` waiter.
pub type WaitUntilSnapshotCompletedError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
crate::operation::describe_snapshots::DescribeSnapshotsOutput,
crate::operation::describe_snapshots::DescribeSnapshotsError,
>;