aws_sdk_bedrockagent/operation/update_knowledge_base/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_knowledge_base::_update_knowledge_base_output::UpdateKnowledgeBaseOutputBuilder;
3
4pub use crate::operation::update_knowledge_base::_update_knowledge_base_input::UpdateKnowledgeBaseInputBuilder;
5
6impl crate::operation::update_knowledge_base::builders::UpdateKnowledgeBaseInputBuilder {
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::update_knowledge_base::UpdateKnowledgeBaseOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_knowledge_base::UpdateKnowledgeBaseError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_knowledge_base();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateKnowledgeBase`.
24///
25/// <p>Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.</p>
26/// <p>You can change the following fields:</p>
27/// <ul>
28/// <li>
29/// <p><code>name</code></p></li>
30/// <li>
31/// <p><code>description</code></p></li>
32/// <li>
33/// <p><code>roleArn</code></p></li>
34/// </ul>
35/// <p>You can't change the <code>knowledgeBaseConfiguration</code> or <code>storageConfiguration</code> fields, so you must specify the same configurations as when you created the knowledge base. You can send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html">GetKnowledgeBase</a> request and copy the same configurations.</p>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct UpdateKnowledgeBaseFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::update_knowledge_base::builders::UpdateKnowledgeBaseInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::update_knowledge_base::UpdateKnowledgeBaseOutput,
45        crate::operation::update_knowledge_base::UpdateKnowledgeBaseError,
46    > for UpdateKnowledgeBaseFluentBuilder
47{
48    fn send(
49        self,
50        config_override: crate::config::Builder,
51    ) -> crate::client::customize::internal::BoxFuture<
52        crate::client::customize::internal::SendResult<
53            crate::operation::update_knowledge_base::UpdateKnowledgeBaseOutput,
54            crate::operation::update_knowledge_base::UpdateKnowledgeBaseError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl UpdateKnowledgeBaseFluentBuilder {
61    /// Creates a new `UpdateKnowledgeBaseFluentBuilder`.
62    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
63        Self {
64            handle,
65            inner: ::std::default::Default::default(),
66            config_override: ::std::option::Option::None,
67        }
68    }
69    /// Access the UpdateKnowledgeBase as a reference.
70    pub fn as_input(&self) -> &crate::operation::update_knowledge_base::builders::UpdateKnowledgeBaseInputBuilder {
71        &self.inner
72    }
73    /// Sends the request and returns the response.
74    ///
75    /// If an error occurs, an `SdkError` will be returned with additional details that
76    /// can be matched against.
77    ///
78    /// By default, any retryable failures will be retried twice. Retry behavior
79    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
80    /// set when configuring the client.
81    pub async fn send(
82        self,
83    ) -> ::std::result::Result<
84        crate::operation::update_knowledge_base::UpdateKnowledgeBaseOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::update_knowledge_base::UpdateKnowledgeBaseError,
87            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
88        >,
89    > {
90        let input = self
91            .inner
92            .build()
93            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
94        let runtime_plugins = crate::operation::update_knowledge_base::UpdateKnowledgeBase::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::update_knowledge_base::UpdateKnowledgeBase::orchestrate(&runtime_plugins, input).await
100    }
101
102    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
103    pub fn customize(
104        self,
105    ) -> crate::client::customize::CustomizableOperation<
106        crate::operation::update_knowledge_base::UpdateKnowledgeBaseOutput,
107        crate::operation::update_knowledge_base::UpdateKnowledgeBaseError,
108        Self,
109    > {
110        crate::client::customize::CustomizableOperation::new(self)
111    }
112    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
113        self.set_config_override(::std::option::Option::Some(config_override.into()));
114        self
115    }
116
117    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
118        self.config_override = config_override;
119        self
120    }
121    /// <p>The unique identifier of the knowledge base to update.</p>
122    pub fn knowledge_base_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.knowledge_base_id(input.into());
124        self
125    }
126    /// <p>The unique identifier of the knowledge base to update.</p>
127    pub fn set_knowledge_base_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_knowledge_base_id(input);
129        self
130    }
131    /// <p>The unique identifier of the knowledge base to update.</p>
132    pub fn get_knowledge_base_id(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_knowledge_base_id()
134    }
135    /// <p>Specifies a new name for the knowledge base.</p>
136    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.name(input.into());
138        self
139    }
140    /// <p>Specifies a new name for the knowledge base.</p>
141    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_name(input);
143        self
144    }
145    /// <p>Specifies a new name for the knowledge base.</p>
146    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_name()
148    }
149    /// <p>Specifies a new description for the knowledge base.</p>
150    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
151        self.inner = self.inner.description(input.into());
152        self
153    }
154    /// <p>Specifies a new description for the knowledge base.</p>
155    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
156        self.inner = self.inner.set_description(input);
157        self
158    }
159    /// <p>Specifies a new description for the knowledge base.</p>
160    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
161        self.inner.get_description()
162    }
163    /// <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
164    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
165        self.inner = self.inner.role_arn(input.into());
166        self
167    }
168    /// <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
169    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
170        self.inner = self.inner.set_role_arn(input);
171        self
172    }
173    /// <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
174    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
175        self.inner.get_role_arn()
176    }
177    /// <p>Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
178    pub fn knowledge_base_configuration(mut self, input: crate::types::KnowledgeBaseConfiguration) -> Self {
179        self.inner = self.inner.knowledge_base_configuration(input);
180        self
181    }
182    /// <p>Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
183    pub fn set_knowledge_base_configuration(mut self, input: ::std::option::Option<crate::types::KnowledgeBaseConfiguration>) -> Self {
184        self.inner = self.inner.set_knowledge_base_configuration(input);
185        self
186    }
187    /// <p>Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
188    pub fn get_knowledge_base_configuration(&self) -> &::std::option::Option<crate::types::KnowledgeBaseConfiguration> {
189        self.inner.get_knowledge_base_configuration()
190    }
191    /// <p>Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
192    pub fn storage_configuration(mut self, input: crate::types::StorageConfiguration) -> Self {
193        self.inner = self.inner.storage_configuration(input);
194        self
195    }
196    /// <p>Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
197    pub fn set_storage_configuration(mut self, input: ::std::option::Option<crate::types::StorageConfiguration>) -> Self {
198        self.inner = self.inner.set_storage_configuration(input);
199        self
200    }
201    /// <p>Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
202    pub fn get_storage_configuration(&self) -> &::std::option::Option<crate::types::StorageConfiguration> {
203        self.inner.get_storage_configuration()
204    }
205}
aws_sdk_bedrockagent/operation/update_knowledge_base/builders.rs

aws_sdk_bedrockagent/operation/update_knowledge_base/
builders.rs
