aws_sdk_imagebuilder/operation/list_images/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_images::_list_images_output::ListImagesOutputBuilder;
3
4pub use crate::operation::list_images::_list_images_input::ListImagesInputBuilder;
5
6impl crate::operation::list_images::builders::ListImagesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_images::ListImagesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_images::ListImagesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_images();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListImages`.
24///
25/// <p>Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListImagesFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::list_images::builders::ListImagesInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::list_images::ListImagesOutput,
35        crate::operation::list_images::ListImagesError,
36    > for ListImagesFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::list_images::ListImagesOutput,
44            crate::operation::list_images::ListImagesError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl ListImagesFluentBuilder {
51    /// Creates a new `ListImagesFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the ListImages as a reference.
60    pub fn as_input(&self) -> &crate::operation::list_images::builders::ListImagesInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::list_images::ListImagesOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::list_images::ListImagesError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::list_images::ListImages::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::list_images::ListImages::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::list_images::ListImagesOutput,
97        crate::operation::list_images::ListImagesError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::list_images::paginator::ListImagesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::list_images::paginator::ListImagesPaginator {
115        crate::operation::list_images::paginator::ListImagesPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.</p>
118    pub fn owner(mut self, input: crate::types::Ownership) -> Self {
119        self.inner = self.inner.owner(input);
120        self
121    }
122    /// <p>The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.</p>
123    pub fn set_owner(mut self, input: ::std::option::Option<crate::types::Ownership>) -> Self {
124        self.inner = self.inner.set_owner(input);
125        self
126    }
127    /// <p>The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.</p>
128    pub fn get_owner(&self) -> &::std::option::Option<crate::types::Ownership> {
129        self.inner.get_owner()
130    }
131    ///
132    /// Appends an item to `filters`.
133    ///
134    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
135    ///
136    /// <p>Use the following filters to streamline results:</p>
137    /// <ul>
138    /// <li>
139    /// <p><code>name</code></p></li>
140    /// <li>
141    /// <p><code>osVersion</code></p></li>
142    /// <li>
143    /// <p><code>platform</code></p></li>
144    /// <li>
145    /// <p><code>type</code></p></li>
146    /// <li>
147    /// <p><code>version</code></p></li>
148    /// </ul>
149    pub fn filters(mut self, input: crate::types::Filter) -> Self {
150        self.inner = self.inner.filters(input);
151        self
152    }
153    /// <p>Use the following filters to streamline results:</p>
154    /// <ul>
155    /// <li>
156    /// <p><code>name</code></p></li>
157    /// <li>
158    /// <p><code>osVersion</code></p></li>
159    /// <li>
160    /// <p><code>platform</code></p></li>
161    /// <li>
162    /// <p><code>type</code></p></li>
163    /// <li>
164    /// <p><code>version</code></p></li>
165    /// </ul>
166    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
167        self.inner = self.inner.set_filters(input);
168        self
169    }
170    /// <p>Use the following filters to streamline results:</p>
171    /// <ul>
172    /// <li>
173    /// <p><code>name</code></p></li>
174    /// <li>
175    /// <p><code>osVersion</code></p></li>
176    /// <li>
177    /// <p><code>platform</code></p></li>
178    /// <li>
179    /// <p><code>type</code></p></li>
180    /// <li>
181    /// <p><code>version</code></p></li>
182    /// </ul>
183    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
184        self.inner.get_filters()
185    }
186    /// <p>Requests a list of images with a specific recipe name.</p>
187    pub fn by_name(mut self, input: bool) -> Self {
188        self.inner = self.inner.by_name(input);
189        self
190    }
191    /// <p>Requests a list of images with a specific recipe name.</p>
192    pub fn set_by_name(mut self, input: ::std::option::Option<bool>) -> Self {
193        self.inner = self.inner.set_by_name(input);
194        self
195    }
196    /// <p>Requests a list of images with a specific recipe name.</p>
197    pub fn get_by_name(&self) -> &::std::option::Option<bool> {
198        self.inner.get_by_name()
199    }
200    /// <p>Specify the maximum number of items to return in a request.</p>
201    pub fn max_results(mut self, input: i32) -> Self {
202        self.inner = self.inner.max_results(input);
203        self
204    }
205    /// <p>Specify the maximum number of items to return in a request.</p>
206    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
207        self.inner = self.inner.set_max_results(input);
208        self
209    }
210    /// <p>Specify the maximum number of items to return in a request.</p>
211    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
212        self.inner.get_max_results()
213    }
214    /// <p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p>
215    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
216        self.inner = self.inner.next_token(input.into());
217        self
218    }
219    /// <p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p>
220    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
221        self.inner = self.inner.set_next_token(input);
222        self
223    }
224    /// <p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p>
225    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
226        self.inner.get_next_token()
227    }
228    /// <p>Includes deprecated images in the response list.</p>
229    pub fn include_deprecated(mut self, input: bool) -> Self {
230        self.inner = self.inner.include_deprecated(input);
231        self
232    }
233    /// <p>Includes deprecated images in the response list.</p>
234    pub fn set_include_deprecated(mut self, input: ::std::option::Option<bool>) -> Self {
235        self.inner = self.inner.set_include_deprecated(input);
236        self
237    }
238    /// <p>Includes deprecated images in the response list.</p>
239    pub fn get_include_deprecated(&self) -> &::std::option::Option<bool> {
240        self.inner.get_include_deprecated()
241    }
242}
aws_sdk_imagebuilder/operation/list_images/builders.rs

aws_sdk_imagebuilder/operation/list_images/
builders.rs
