aws_sdk_qbusiness/client/
get_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 [`GetRetriever`](crate::operation::get_retriever::builders::GetRetrieverFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_retriever::builders::GetRetrieverFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_retriever::builders::GetRetrieverFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application using the retriever.</p><br>
7    ///   - [`retriever_id(impl Into<String>)`](crate::operation::get_retriever::builders::GetRetrieverFluentBuilder::retriever_id) / [`set_retriever_id(Option<String>)`](crate::operation::get_retriever::builders::GetRetrieverFluentBuilder::set_retriever_id):<br>required: **true**<br><p>The identifier of the retriever.</p><br>
8    /// - On success, responds with [`GetRetrieverOutput`](crate::operation::get_retriever::GetRetrieverOutput) with field(s):
9    ///   - [`application_id(Option<String>)`](crate::operation::get_retriever::GetRetrieverOutput::application_id): <p>The identifier of the Amazon Q Business application using the retriever.</p>
10    ///   - [`retriever_id(Option<String>)`](crate::operation::get_retriever::GetRetrieverOutput::retriever_id): <p>The identifier of the retriever.</p>
11    ///   - [`retriever_arn(Option<String>)`](crate::operation::get_retriever::GetRetrieverOutput::retriever_arn): <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
12    ///   - [`r#type(Option<RetrieverType>)`](crate::operation::get_retriever::GetRetrieverOutput::type): <p>The type of the retriever.</p>
13    ///   - [`status(Option<RetrieverStatus>)`](crate::operation::get_retriever::GetRetrieverOutput::status): <p>The status of the retriever.</p>
14    ///   - [`display_name(Option<String>)`](crate::operation::get_retriever::GetRetrieverOutput::display_name): <p>The name of the retriever.</p>
15    ///   - [`configuration(Option<RetrieverConfiguration>)`](crate::operation::get_retriever::GetRetrieverOutput::configuration): <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
16    ///   - [`role_arn(Option<String>)`](crate::operation::get_retriever::GetRetrieverOutput::role_arn): <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
17    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_retriever::GetRetrieverOutput::created_at): <p>The Unix timestamp when the retriever was created.</p>
18    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_retriever::GetRetrieverOutput::updated_at): <p>The Unix timestamp when the retriever was last updated.</p>
19    /// - On failure, responds with [`SdkError<GetRetrieverError>`](crate::operation::get_retriever::GetRetrieverError)
20    pub fn get_retriever(&self) -> crate::operation::get_retriever::builders::GetRetrieverFluentBuilder {
21        crate::operation::get_retriever::builders::GetRetrieverFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_qbusiness/client/get_retriever.rs

aws_sdk_qbusiness/client/
get_retriever.rs
