aws_sdk_ec2/waiters/image_available.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `image_available` waiter.
5///
6/// This builder is intended to be used similar to the other fluent builders for
7/// normal operations on the client. However, instead of a `send` method, it has
8/// a `wait` method that takes a maximum amount of time to wait.
9///
10/// Construct this fluent builder using the client by importing the
11/// [`Waiters`](crate::client::Waiters) trait and calling the methods
12/// prefixed with `wait_until`.
13///
14#[derive(::std::clone::Clone, ::std::fmt::Debug)]
15pub struct ImageAvailableFluentBuilder {
16 handle: ::std::sync::Arc<crate::client::Handle>,
17 inner: crate::operation::describe_images::builders::DescribeImagesInputBuilder,
18}
19impl ImageAvailableFluentBuilder {
20 /// Creates a new `ImageAvailableFluentBuilder`.
21 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
22 Self {
23 handle,
24 inner: ::std::default::Default::default(),
25 }
26 }
27 /// Access the DescribeImages as a reference.
28 pub fn as_input(&self) -> &crate::operation::describe_images::builders::DescribeImagesInputBuilder {
29 &self.inner
30 }
31 /// Wait for `image_available`
32 pub async fn wait(
33 self,
34 max_wait: ::std::time::Duration,
35 ) -> ::std::result::Result<crate::waiters::image_available::ImageAvailableFinalPoll, crate::waiters::image_available::WaitUntilImageAvailableError>
36 {
37 let input = self
38 .inner
39 .build()
40 .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
41 let runtime_plugins = crate::operation::describe_images::DescribeImages::operation_runtime_plugins(
42 self.handle.runtime_plugins.clone(),
43 &self.handle.conf,
44 ::std::option::Option::None,
45 )
46 .with_operation_plugin(crate::sdk_feature_tracker::waiter::WaiterFeatureTrackerRuntimePlugin::new());
47 let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
48 let runtime_components_builder = runtime_plugins
49 .apply_client_configuration(&mut cfg)
50 .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
51 let time_components = runtime_components_builder.into_time_components();
52 let sleep_impl = time_components.sleep_impl().expect("a sleep impl is required by waiters");
53 let time_source = time_components.time_source().expect("a time source is required by waiters");
54
55 let acceptor = move |result: ::std::result::Result<
56 &crate::operation::describe_images::DescribeImagesOutput,
57 &crate::operation::describe_images::DescribeImagesError,
58 >| {
59 // Matches: {"output":{"path":"Images[].State","expected":"available","comparator":"allStringEquals"}}
60 if crate::waiters::matchers::match_describe_images_3acc318c83d8a4452(result) {
61 return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
62 }
63 // Matches: {"output":{"path":"Images[].State","expected":"failed","comparator":"anyStringEquals"}}
64 if crate::waiters::matchers::match_describe_images_059a66e170d3df7a5(result) {
65 return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
66 }
67 ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
68 };
69 let operation = move || {
70 let input = input.clone();
71 let runtime_plugins = runtime_plugins.clone();
72 async move { crate::operation::describe_images::DescribeImages::orchestrate(&runtime_plugins, input).await }
73 };
74 let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
75 .min_delay(::std::time::Duration::from_secs(15))
76 .max_delay(::std::time::Duration::from_secs(120))
77 .max_wait(max_wait)
78 .time_source(time_source)
79 .sleep_impl(sleep_impl)
80 .acceptor(acceptor)
81 .operation(operation)
82 .build();
83 ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
84 }
85 ///
86 /// Appends an item to `ExecutableUsers`.
87 ///
88 /// To override the contents of this collection use [`set_executable_users`](Self::set_executable_users).
89 ///
90 /// <p>Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, <code>self</code> (the sender of the request), or <code>all</code> (public AMIs).</p>
91 /// <ul>
92 /// <li>
93 /// <p>If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.</p></li>
94 /// <li>
95 /// <p>If you specify <code>self</code> or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.</p></li>
96 /// <li>
97 /// <p>If you specify <code>all</code>, all public AMIs are returned.</p></li>
98 /// </ul>
99 pub fn executable_users(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
100 self.inner = self.inner.executable_users(input.into());
101 self
102 }
103 /// <p>Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, <code>self</code> (the sender of the request), or <code>all</code> (public AMIs).</p>
104 /// <ul>
105 /// <li>
106 /// <p>If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.</p></li>
107 /// <li>
108 /// <p>If you specify <code>self</code> or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.</p></li>
109 /// <li>
110 /// <p>If you specify <code>all</code>, all public AMIs are returned.</p></li>
111 /// </ul>
112 pub fn set_executable_users(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
113 self.inner = self.inner.set_executable_users(input);
114 self
115 }
116 /// <p>Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, <code>self</code> (the sender of the request), or <code>all</code> (public AMIs).</p>
117 /// <ul>
118 /// <li>
119 /// <p>If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.</p></li>
120 /// <li>
121 /// <p>If you specify <code>self</code> or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.</p></li>
122 /// <li>
123 /// <p>If you specify <code>all</code>, all public AMIs are returned.</p></li>
124 /// </ul>
125 pub fn get_executable_users(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
126 self.inner.get_executable_users()
127 }
128 ///
129 /// Appends an item to `ImageIds`.
130 ///
131 /// To override the contents of this collection use [`set_image_ids`](Self::set_image_ids).
132 ///
133 /// <p>The image IDs.</p>
134 /// <p>Default: Describes all images available to you.</p>
135 pub fn image_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136 self.inner = self.inner.image_ids(input.into());
137 self
138 }
139 /// <p>The image IDs.</p>
140 /// <p>Default: Describes all images available to you.</p>
141 pub fn set_image_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
142 self.inner = self.inner.set_image_ids(input);
143 self
144 }
145 /// <p>The image IDs.</p>
146 /// <p>Default: Describes all images available to you.</p>
147 pub fn get_image_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
148 self.inner.get_image_ids()
149 }
150 ///
151 /// Appends an item to `Owners`.
152 ///
153 /// To override the contents of this collection use [`set_owners`](Self::set_owners).
154 ///
155 /// <p>Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, <code>amazon</code>, <code>aws-backup-vault</code>, and <code>aws-marketplace</code>. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.</p>
156 pub fn owners(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157 self.inner = self.inner.owners(input.into());
158 self
159 }
160 /// <p>Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, <code>amazon</code>, <code>aws-backup-vault</code>, and <code>aws-marketplace</code>. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.</p>
161 pub fn set_owners(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
162 self.inner = self.inner.set_owners(input);
163 self
164 }
165 /// <p>Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, <code>self</code>, <code>amazon</code>, <code>aws-backup-vault</code>, and <code>aws-marketplace</code>. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.</p>
166 pub fn get_owners(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
167 self.inner.get_owners()
168 }
169 /// <p>Specifies whether to include deprecated AMIs.</p>
170 /// <p>Default: No deprecated AMIs are included in the response.</p><note>
171 /// <p>If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.</p>
172 /// </note>
173 pub fn include_deprecated(mut self, input: bool) -> Self {
174 self.inner = self.inner.include_deprecated(input);
175 self
176 }
177 /// <p>Specifies whether to include deprecated AMIs.</p>
178 /// <p>Default: No deprecated AMIs are included in the response.</p><note>
179 /// <p>If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.</p>
180 /// </note>
181 pub fn set_include_deprecated(mut self, input: ::std::option::Option<bool>) -> Self {
182 self.inner = self.inner.set_include_deprecated(input);
183 self
184 }
185 /// <p>Specifies whether to include deprecated AMIs.</p>
186 /// <p>Default: No deprecated AMIs are included in the response.</p><note>
187 /// <p>If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.</p>
188 /// </note>
189 pub fn get_include_deprecated(&self) -> &::std::option::Option<bool> {
190 self.inner.get_include_deprecated()
191 }
192 /// <p>Specifies whether to include disabled AMIs.</p>
193 /// <p>Default: No disabled AMIs are included in the response.</p>
194 pub fn include_disabled(mut self, input: bool) -> Self {
195 self.inner = self.inner.include_disabled(input);
196 self
197 }
198 /// <p>Specifies whether to include disabled AMIs.</p>
199 /// <p>Default: No disabled AMIs are included in the response.</p>
200 pub fn set_include_disabled(mut self, input: ::std::option::Option<bool>) -> Self {
201 self.inner = self.inner.set_include_disabled(input);
202 self
203 }
204 /// <p>Specifies whether to include disabled AMIs.</p>
205 /// <p>Default: No disabled AMIs are included in the response.</p>
206 pub fn get_include_disabled(&self) -> &::std::option::Option<bool> {
207 self.inner.get_include_disabled()
208 }
209 /// <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>
210 pub fn max_results(mut self, input: i32) -> Self {
211 self.inner = self.inner.max_results(input);
212 self
213 }
214 /// <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>
215 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
216 self.inner = self.inner.set_max_results(input);
217 self
218 }
219 /// <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>
220 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
221 self.inner.get_max_results()
222 }
223 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
224 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
225 self.inner = self.inner.next_token(input.into());
226 self
227 }
228 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
229 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
230 self.inner = self.inner.set_next_token(input);
231 self
232 }
233 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
234 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
235 self.inner.get_next_token()
236 }
237 /// <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>
238 pub fn dry_run(mut self, input: bool) -> Self {
239 self.inner = self.inner.dry_run(input);
240 self
241 }
242 /// <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>
243 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
244 self.inner = self.inner.set_dry_run(input);
245 self
246 }
247 /// <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>
248 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
249 self.inner.get_dry_run()
250 }
251 ///
252 /// Appends an item to `Filters`.
253 ///
254 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
255 ///
256 /// <p>The filters.</p>
257 /// <ul>
258 /// <li>
259 /// <p><code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code> | <code>x86_64_mac</code> | <code>arm64_mac</code>).</p></li>
260 /// <li>
261 /// <p><code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.</p></li>
262 /// <li>
263 /// <p><code>block-device-mapping.device-name</code> - The device name specified in the block device mapping (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p></li>
264 /// <li>
265 /// <p><code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p></li>
266 /// <li>
267 /// <p><code>block-device-mapping.volume-size</code> - The volume size of the Amazon EBS volume, in GiB.</p></li>
268 /// <li>
269 /// <p><code>block-device-mapping.volume-type</code> - The volume type of the Amazon EBS volume (<code>io1</code> | <code>io2</code> | <code>gp2</code> | <code>gp3</code> | <code>sc1 </code>| <code>st1</code> | <code>standard</code>).</p></li>
270 /// <li>
271 /// <p><code>block-device-mapping.encrypted</code> - A Boolean that indicates whether the Amazon EBS volume is encrypted.</p></li>
272 /// <li>
273 /// <p><code>creation-date</code> - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2021-09-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2021-09-29T*</code>, which matches an entire day.</p></li>
274 /// <li>
275 /// <p><code>description</code> - The description of the image (provided during image creation).</p></li>
276 /// <li>
277 /// <p><code>ena-support</code> - A Boolean that indicates whether enhanced networking with ENA is enabled.</p></li>
278 /// <li>
279 /// <p><code>free-tier-eligible</code> - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (<code>true</code> | <code>false</code>).</p></li>
280 /// <li>
281 /// <p><code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>).</p></li>
282 /// <li>
283 /// <p><code>image-allowed</code> - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs.</p></li>
284 /// <li>
285 /// <p><code>image-id</code> - The ID of the image.</p></li>
286 /// <li>
287 /// <p><code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>).</p></li>
288 /// <li>
289 /// <p><code>is-public</code> - A Boolean that indicates whether the image is public.</p></li>
290 /// <li>
291 /// <p><code>kernel-id</code> - The kernel ID.</p></li>
292 /// <li>
293 /// <p><code>manifest-location</code> - The location of the image manifest.</p></li>
294 /// <li>
295 /// <p><code>name</code> - The name of the AMI (provided during image creation).</p></li>
296 /// <li>
297 /// <p><code>owner-alias</code> - The owner alias (<code>amazon</code> | <code>aws-backup-vault</code> | <code>aws-marketplace</code>). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
298 /// <li>
299 /// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
300 /// <li>
301 /// <p><code>platform</code> - The platform. The only supported value is <code>windows</code>.</p></li>
302 /// <li>
303 /// <p><code>product-code</code> - The product code.</p></li>
304 /// <li>
305 /// <p><code>product-code.type</code> - The type of the product code (<code>marketplace</code>).</p></li>
306 /// <li>
307 /// <p><code>ramdisk-id</code> - The RAM disk ID.</p></li>
308 /// <li>
309 /// <p><code>root-device-name</code> - The device name of the root device volume (for example, <code>/dev/sda1</code>).</p></li>
310 /// <li>
311 /// <p><code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>).</p></li>
312 /// <li>
313 /// <p><code>source-image-id</code> - The ID of the source AMI from which the AMI was created.</p></li>
314 /// <li>
315 /// <p><code>source-image-region</code> - The Region of the source AMI.</p></li>
316 /// <li>
317 /// <p><code>source-instance-id</code> - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html">CreateImage</a>.</p></li>
318 /// <li>
319 /// <p><code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>).</p></li>
320 /// <li>
321 /// <p><code>state-reason-code</code> - The reason code for the state change.</p></li>
322 /// <li>
323 /// <p><code>state-reason-message</code> - The message for the state change.</p></li>
324 /// <li>
325 /// <p><code>sriov-net-support</code> - A value of <code>simple</code> indicates that enhanced networking with the Intel 82599 VF interface is enabled.</p></li>
326 /// <li>
327 /// <p><code>tag:<key></key></code> - 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.</p></li>
328 /// <li>
329 /// <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>
330 /// <li>
331 /// <p><code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>).</p></li>
332 /// </ul>
333 pub fn filters(mut self, input: crate::types::Filter) -> Self {
334 self.inner = self.inner.filters(input);
335 self
336 }
337 /// <p>The filters.</p>
338 /// <ul>
339 /// <li>
340 /// <p><code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code> | <code>x86_64_mac</code> | <code>arm64_mac</code>).</p></li>
341 /// <li>
342 /// <p><code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.</p></li>
343 /// <li>
344 /// <p><code>block-device-mapping.device-name</code> - The device name specified in the block device mapping (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p></li>
345 /// <li>
346 /// <p><code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p></li>
347 /// <li>
348 /// <p><code>block-device-mapping.volume-size</code> - The volume size of the Amazon EBS volume, in GiB.</p></li>
349 /// <li>
350 /// <p><code>block-device-mapping.volume-type</code> - The volume type of the Amazon EBS volume (<code>io1</code> | <code>io2</code> | <code>gp2</code> | <code>gp3</code> | <code>sc1 </code>| <code>st1</code> | <code>standard</code>).</p></li>
351 /// <li>
352 /// <p><code>block-device-mapping.encrypted</code> - A Boolean that indicates whether the Amazon EBS volume is encrypted.</p></li>
353 /// <li>
354 /// <p><code>creation-date</code> - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2021-09-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2021-09-29T*</code>, which matches an entire day.</p></li>
355 /// <li>
356 /// <p><code>description</code> - The description of the image (provided during image creation).</p></li>
357 /// <li>
358 /// <p><code>ena-support</code> - A Boolean that indicates whether enhanced networking with ENA is enabled.</p></li>
359 /// <li>
360 /// <p><code>free-tier-eligible</code> - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (<code>true</code> | <code>false</code>).</p></li>
361 /// <li>
362 /// <p><code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>).</p></li>
363 /// <li>
364 /// <p><code>image-allowed</code> - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs.</p></li>
365 /// <li>
366 /// <p><code>image-id</code> - The ID of the image.</p></li>
367 /// <li>
368 /// <p><code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>).</p></li>
369 /// <li>
370 /// <p><code>is-public</code> - A Boolean that indicates whether the image is public.</p></li>
371 /// <li>
372 /// <p><code>kernel-id</code> - The kernel ID.</p></li>
373 /// <li>
374 /// <p><code>manifest-location</code> - The location of the image manifest.</p></li>
375 /// <li>
376 /// <p><code>name</code> - The name of the AMI (provided during image creation).</p></li>
377 /// <li>
378 /// <p><code>owner-alias</code> - The owner alias (<code>amazon</code> | <code>aws-backup-vault</code> | <code>aws-marketplace</code>). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
379 /// <li>
380 /// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
381 /// <li>
382 /// <p><code>platform</code> - The platform. The only supported value is <code>windows</code>.</p></li>
383 /// <li>
384 /// <p><code>product-code</code> - The product code.</p></li>
385 /// <li>
386 /// <p><code>product-code.type</code> - The type of the product code (<code>marketplace</code>).</p></li>
387 /// <li>
388 /// <p><code>ramdisk-id</code> - The RAM disk ID.</p></li>
389 /// <li>
390 /// <p><code>root-device-name</code> - The device name of the root device volume (for example, <code>/dev/sda1</code>).</p></li>
391 /// <li>
392 /// <p><code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>).</p></li>
393 /// <li>
394 /// <p><code>source-image-id</code> - The ID of the source AMI from which the AMI was created.</p></li>
395 /// <li>
396 /// <p><code>source-image-region</code> - The Region of the source AMI.</p></li>
397 /// <li>
398 /// <p><code>source-instance-id</code> - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html">CreateImage</a>.</p></li>
399 /// <li>
400 /// <p><code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>).</p></li>
401 /// <li>
402 /// <p><code>state-reason-code</code> - The reason code for the state change.</p></li>
403 /// <li>
404 /// <p><code>state-reason-message</code> - The message for the state change.</p></li>
405 /// <li>
406 /// <p><code>sriov-net-support</code> - A value of <code>simple</code> indicates that enhanced networking with the Intel 82599 VF interface is enabled.</p></li>
407 /// <li>
408 /// <p><code>tag:<key></key></code> - 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.</p></li>
409 /// <li>
410 /// <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>
411 /// <li>
412 /// <p><code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>).</p></li>
413 /// </ul>
414 pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
415 self.inner = self.inner.set_filters(input);
416 self
417 }
418 /// <p>The filters.</p>
419 /// <ul>
420 /// <li>
421 /// <p><code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code> | <code>arm64</code> | <code>x86_64_mac</code> | <code>arm64_mac</code>).</p></li>
422 /// <li>
423 /// <p><code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.</p></li>
424 /// <li>
425 /// <p><code>block-device-mapping.device-name</code> - The device name specified in the block device mapping (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p></li>
426 /// <li>
427 /// <p><code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p></li>
428 /// <li>
429 /// <p><code>block-device-mapping.volume-size</code> - The volume size of the Amazon EBS volume, in GiB.</p></li>
430 /// <li>
431 /// <p><code>block-device-mapping.volume-type</code> - The volume type of the Amazon EBS volume (<code>io1</code> | <code>io2</code> | <code>gp2</code> | <code>gp3</code> | <code>sc1 </code>| <code>st1</code> | <code>standard</code>).</p></li>
432 /// <li>
433 /// <p><code>block-device-mapping.encrypted</code> - A Boolean that indicates whether the Amazon EBS volume is encrypted.</p></li>
434 /// <li>
435 /// <p><code>creation-date</code> - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2021-09-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2021-09-29T*</code>, which matches an entire day.</p></li>
436 /// <li>
437 /// <p><code>description</code> - The description of the image (provided during image creation).</p></li>
438 /// <li>
439 /// <p><code>ena-support</code> - A Boolean that indicates whether enhanced networking with ENA is enabled.</p></li>
440 /// <li>
441 /// <p><code>free-tier-eligible</code> - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (<code>true</code> | <code>false</code>).</p></li>
442 /// <li>
443 /// <p><code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>).</p></li>
444 /// <li>
445 /// <p><code>image-allowed</code> - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs.</p></li>
446 /// <li>
447 /// <p><code>image-id</code> - The ID of the image.</p></li>
448 /// <li>
449 /// <p><code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>).</p></li>
450 /// <li>
451 /// <p><code>is-public</code> - A Boolean that indicates whether the image is public.</p></li>
452 /// <li>
453 /// <p><code>kernel-id</code> - The kernel ID.</p></li>
454 /// <li>
455 /// <p><code>manifest-location</code> - The location of the image manifest.</p></li>
456 /// <li>
457 /// <p><code>name</code> - The name of the AMI (provided during image creation).</p></li>
458 /// <li>
459 /// <p><code>owner-alias</code> - The owner alias (<code>amazon</code> | <code>aws-backup-vault</code> | <code>aws-marketplace</code>). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
460 /// <li>
461 /// <p><code>owner-id</code> - The Amazon Web Services account ID of the owner. We recommend that you use the <b>Owner</b> request parameter instead of this filter.</p></li>
462 /// <li>
463 /// <p><code>platform</code> - The platform. The only supported value is <code>windows</code>.</p></li>
464 /// <li>
465 /// <p><code>product-code</code> - The product code.</p></li>
466 /// <li>
467 /// <p><code>product-code.type</code> - The type of the product code (<code>marketplace</code>).</p></li>
468 /// <li>
469 /// <p><code>ramdisk-id</code> - The RAM disk ID.</p></li>
470 /// <li>
471 /// <p><code>root-device-name</code> - The device name of the root device volume (for example, <code>/dev/sda1</code>).</p></li>
472 /// <li>
473 /// <p><code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>).</p></li>
474 /// <li>
475 /// <p><code>source-image-id</code> - The ID of the source AMI from which the AMI was created.</p></li>
476 /// <li>
477 /// <p><code>source-image-region</code> - The Region of the source AMI.</p></li>
478 /// <li>
479 /// <p><code>source-instance-id</code> - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html">CreateImage</a>.</p></li>
480 /// <li>
481 /// <p><code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>).</p></li>
482 /// <li>
483 /// <p><code>state-reason-code</code> - The reason code for the state change.</p></li>
484 /// <li>
485 /// <p><code>state-reason-message</code> - The message for the state change.</p></li>
486 /// <li>
487 /// <p><code>sriov-net-support</code> - A value of <code>simple</code> indicates that enhanced networking with the Intel 82599 VF interface is enabled.</p></li>
488 /// <li>
489 /// <p><code>tag:<key></key></code> - 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.</p></li>
490 /// <li>
491 /// <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>
492 /// <li>
493 /// <p><code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>).</p></li>
494 /// </ul>
495 pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
496 self.inner.get_filters()
497 }
498}
499
500/// Successful return type for the `image_available` waiter.
501pub type ImageAvailableFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
502 crate::operation::describe_images::DescribeImagesOutput,
503 ::aws_smithy_runtime_api::client::result::SdkError<
504 crate::operation::describe_images::DescribeImagesError,
505 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
506 >,
507>;
508
509/// Error type for the `image_available` waiter.
510pub type WaitUntilImageAvailableError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
511 crate::operation::describe_images::DescribeImagesOutput,
512 crate::operation::describe_images::DescribeImagesError,
513>;