aws_sdk_bedrock/operation/list_custom_models/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_custom_models::_list_custom_models_output::ListCustomModelsOutputBuilder;
3
4pub use crate::operation::list_custom_models::_list_custom_models_input::ListCustomModelsInputBuilder;
5
6impl crate::operation::list_custom_models::builders::ListCustomModelsInputBuilder {
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_custom_models::ListCustomModelsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_custom_models::ListCustomModelsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_custom_models();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListCustomModels`.
24///
25/// <p>Returns a list of the custom models that you have created with the <code>CreateModelCustomizationJob</code> operation.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListCustomModelsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_custom_models::builders::ListCustomModelsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_custom_models::ListCustomModelsOutput,
36        crate::operation::list_custom_models::ListCustomModelsError,
37    > for ListCustomModelsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::list_custom_models::ListCustomModelsOutput,
45            crate::operation::list_custom_models::ListCustomModelsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListCustomModelsFluentBuilder {
52    /// Creates a new `ListCustomModelsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the ListCustomModels as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_custom_models::builders::ListCustomModelsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::list_custom_models::ListCustomModelsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_custom_models::ListCustomModelsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::list_custom_models::ListCustomModels::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_custom_models::ListCustomModels::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::list_custom_models::ListCustomModelsOutput,
98        crate::operation::list_custom_models::ListCustomModelsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_custom_models::paginator::ListCustomModelsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_custom_models::paginator::ListCustomModelsPaginator {
116        crate::operation::list_custom_models::paginator::ListCustomModelsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>Return custom models created before the specified time.</p>
119    pub fn creation_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
120        self.inner = self.inner.creation_time_before(input);
121        self
122    }
123    /// <p>Return custom models created before the specified time.</p>
124    pub fn set_creation_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
125        self.inner = self.inner.set_creation_time_before(input);
126        self
127    }
128    /// <p>Return custom models created before the specified time.</p>
129    pub fn get_creation_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
130        self.inner.get_creation_time_before()
131    }
132    /// <p>Return custom models created after the specified time.</p>
133    pub fn creation_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
134        self.inner = self.inner.creation_time_after(input);
135        self
136    }
137    /// <p>Return custom models created after the specified time.</p>
138    pub fn set_creation_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
139        self.inner = self.inner.set_creation_time_after(input);
140        self
141    }
142    /// <p>Return custom models created after the specified time.</p>
143    pub fn get_creation_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
144        self.inner.get_creation_time_after()
145    }
146    /// <p>Return custom models only if the job name contains these characters.</p>
147    pub fn name_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.name_contains(input.into());
149        self
150    }
151    /// <p>Return custom models only if the job name contains these characters.</p>
152    pub fn set_name_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153        self.inner = self.inner.set_name_contains(input);
154        self
155    }
156    /// <p>Return custom models only if the job name contains these characters.</p>
157    pub fn get_name_contains(&self) -> &::std::option::Option<::std::string::String> {
158        self.inner.get_name_contains()
159    }
160    /// <p>Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.</p>
161    pub fn base_model_arn_equals(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
162        self.inner = self.inner.base_model_arn_equals(input.into());
163        self
164    }
165    /// <p>Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.</p>
166    pub fn set_base_model_arn_equals(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
167        self.inner = self.inner.set_base_model_arn_equals(input);
168        self
169    }
170    /// <p>Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.</p>
171    pub fn get_base_model_arn_equals(&self) -> &::std::option::Option<::std::string::String> {
172        self.inner.get_base_model_arn_equals()
173    }
174    /// <p>Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.</p>
175    pub fn foundation_model_arn_equals(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
176        self.inner = self.inner.foundation_model_arn_equals(input.into());
177        self
178    }
179    /// <p>Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.</p>
180    pub fn set_foundation_model_arn_equals(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
181        self.inner = self.inner.set_foundation_model_arn_equals(input);
182        self
183    }
184    /// <p>Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.</p>
185    pub fn get_foundation_model_arn_equals(&self) -> &::std::option::Option<::std::string::String> {
186        self.inner.get_foundation_model_arn_equals()
187    }
188    /// <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
189    pub fn max_results(mut self, input: i32) -> Self {
190        self.inner = self.inner.max_results(input);
191        self
192    }
193    /// <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
194    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
195        self.inner = self.inner.set_max_results(input);
196        self
197    }
198    /// <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
199    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
200        self.inner.get_max_results()
201    }
202    /// <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
203    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
204        self.inner = self.inner.next_token(input.into());
205        self
206    }
207    /// <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
208    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
209        self.inner = self.inner.set_next_token(input);
210        self
211    }
212    /// <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
213    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
214        self.inner.get_next_token()
215    }
216    /// <p>The field to sort by in the returned list of models.</p>
217    pub fn sort_by(mut self, input: crate::types::SortModelsBy) -> Self {
218        self.inner = self.inner.sort_by(input);
219        self
220    }
221    /// <p>The field to sort by in the returned list of models.</p>
222    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SortModelsBy>) -> Self {
223        self.inner = self.inner.set_sort_by(input);
224        self
225    }
226    /// <p>The field to sort by in the returned list of models.</p>
227    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SortModelsBy> {
228        self.inner.get_sort_by()
229    }
230    /// <p>The sort order of the results.</p>
231    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
232        self.inner = self.inner.sort_order(input);
233        self
234    }
235    /// <p>The sort order of the results.</p>
236    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
237        self.inner = self.inner.set_sort_order(input);
238        self
239    }
240    /// <p>The sort order of the results.</p>
241    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
242        self.inner.get_sort_order()
243    }
244    /// <p>Return custom models depending on if the current account owns them (<code>true</code>) or if they were shared with the current account (<code>false</code>).</p>
245    pub fn is_owned(mut self, input: bool) -> Self {
246        self.inner = self.inner.is_owned(input);
247        self
248    }
249    /// <p>Return custom models depending on if the current account owns them (<code>true</code>) or if they were shared with the current account (<code>false</code>).</p>
250    pub fn set_is_owned(mut self, input: ::std::option::Option<bool>) -> Self {
251        self.inner = self.inner.set_is_owned(input);
252        self
253    }
254    /// <p>Return custom models depending on if the current account owns them (<code>true</code>) or if they were shared with the current account (<code>false</code>).</p>
255    pub fn get_is_owned(&self) -> &::std::option::Option<bool> {
256        self.inner.get_is_owned()
257    }
258    /// <p>The status of them model to filter results by. Possible values include:</p>
259    /// <ul>
260    /// <li>
261    /// <p><code>Creating</code> - Include only models that are currently being created and validated.</p></li>
262    /// <li>
263    /// <p><code>Active</code> - Include only models that have been successfully created and are ready for use.</p></li>
264    /// <li>
265    /// <p><code>Failed</code> - Include only models where the creation process failed.</p></li>
266    /// </ul>
267    /// <p>If you don't specify a status, the API returns models in all states.</p>
268    pub fn model_status(mut self, input: crate::types::ModelStatus) -> Self {
269        self.inner = self.inner.model_status(input);
270        self
271    }
272    /// <p>The status of them model to filter results by. Possible values include:</p>
273    /// <ul>
274    /// <li>
275    /// <p><code>Creating</code> - Include only models that are currently being created and validated.</p></li>
276    /// <li>
277    /// <p><code>Active</code> - Include only models that have been successfully created and are ready for use.</p></li>
278    /// <li>
279    /// <p><code>Failed</code> - Include only models where the creation process failed.</p></li>
280    /// </ul>
281    /// <p>If you don't specify a status, the API returns models in all states.</p>
282    pub fn set_model_status(mut self, input: ::std::option::Option<crate::types::ModelStatus>) -> Self {
283        self.inner = self.inner.set_model_status(input);
284        self
285    }
286    /// <p>The status of them model to filter results by. Possible values include:</p>
287    /// <ul>
288    /// <li>
289    /// <p><code>Creating</code> - Include only models that are currently being created and validated.</p></li>
290    /// <li>
291    /// <p><code>Active</code> - Include only models that have been successfully created and are ready for use.</p></li>
292    /// <li>
293    /// <p><code>Failed</code> - Include only models where the creation process failed.</p></li>
294    /// </ul>
295    /// <p>If you don't specify a status, the API returns models in all states.</p>
296    pub fn get_model_status(&self) -> &::std::option::Option<crate::types::ModelStatus> {
297        self.inner.get_model_status()
298    }
299}
aws_sdk_bedrock/operation/list_custom_models/builders.rs

aws_sdk_bedrock/operation/list_custom_models/
builders.rs
