aws_sdk_qbusiness/client/update_retriever.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`UpdateRetriever`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`application_id(impl Into<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of your Amazon Q Business application.</p><br>
7 /// - [`retriever_id(impl Into<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::retriever_id) / [`set_retriever_id(Option<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::set_retriever_id):<br>required: **true**<br><p>The identifier of your retriever.</p><br>
8 /// - [`configuration(RetrieverConfiguration)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::configuration) / [`set_configuration(Option<RetrieverConfiguration>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::set_configuration):<br>required: **false**<br><p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p><br>
9 /// - [`display_name(impl Into<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::set_display_name):<br>required: **false**<br><p>The name of your retriever.</p><br>
10 /// - [`role_arn(impl Into<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.</p><br>
11 /// - On success, responds with [`UpdateRetrieverOutput`](crate::operation::update_retriever::UpdateRetrieverOutput)
12 /// - On failure, responds with [`SdkError<UpdateRetrieverError>`](crate::operation::update_retriever::UpdateRetrieverError)
13 pub fn update_retriever(&self) -> crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder {
14 crate::operation::update_retriever::builders::UpdateRetrieverFluentBuilder::new(self.handle.clone())
15 }
16}