aws_sdk_qbusiness/client/
get_data_source.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 [`GetDataSource`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application.</p><br>
7    ///   - [`index_id(impl Into<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::set_index_id):<br>required: **true**<br><p>The identfier of the index used with the data source connector.</p><br>
8    ///   - [`data_source_id(impl Into<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::set_data_source_id):<br>required: **true**<br><p>The identifier of the data source connector.</p><br>
9    /// - On success, responds with [`GetDataSourceOutput`](crate::operation::get_data_source::GetDataSourceOutput) with field(s):
10    ///   - [`application_id(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::application_id): <p>The identifier of the Amazon Q Business application.</p>
11    ///   - [`index_id(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::index_id): <p>The identifier of the index linked to the data source connector.</p>
12    ///   - [`data_source_id(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::data_source_id): <p>The identifier of the data source connector.</p>
13    ///   - [`data_source_arn(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::data_source_arn): <p>The Amazon Resource Name (ARN) of the data source.</p>
14    ///   - [`display_name(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::display_name): <p>The name for the data source connector.</p>
15    ///   - [`r#type(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::type): <p>The type of the data source connector. For example, <code>S3</code>.</p>
16    ///   - [`configuration(Option<Document>)`](crate::operation::get_data_source::GetDataSourceOutput::configuration): <p>The details of how the data source connector is configured.</p>
17    ///   - [`vpc_configuration(Option<DataSourceVpcConfiguration>)`](crate::operation::get_data_source::GetDataSourceOutput::vpc_configuration): <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.</p>
18    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_data_source::GetDataSourceOutput::created_at): <p>The Unix timestamp when the data source connector was created.</p>
19    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_data_source::GetDataSourceOutput::updated_at): <p>The Unix timestamp when the data source connector was last updated.</p>
20    ///   - [`description(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::description): <p>The description for the data source connector.</p>
21    ///   - [`status(Option<DataSourceStatus>)`](crate::operation::get_data_source::GetDataSourceOutput::status): <p>The current status of the data source connector. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
22    ///   - [`sync_schedule(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::sync_schedule): <p>The schedule for Amazon Q Business to update the index.</p>
23    ///   - [`role_arn(Option<String>)`](crate::operation::get_data_source::GetDataSourceOutput::role_arn): <p>The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.</p>
24    ///   - [`error(Option<ErrorDetail>)`](crate::operation::get_data_source::GetDataSourceOutput::error): <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
25    ///   - [`document_enrichment_configuration(Option<DocumentEnrichmentConfiguration>)`](crate::operation::get_data_source::GetDataSourceOutput::document_enrichment_configuration): <p>Provides the configuration information for altering document metadata and content during the document ingestion process.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>.</p>
26    ///   - [`media_extraction_configuration(Option<MediaExtractionConfiguration>)`](crate::operation::get_data_source::GetDataSourceOutput::media_extraction_configuration): <p>The configuration for extracting information from media in documents for the data source.</p>
27    /// - On failure, responds with [`SdkError<GetDataSourceError>`](crate::operation::get_data_source::GetDataSourceError)
28    pub fn get_data_source(&self) -> crate::operation::get_data_source::builders::GetDataSourceFluentBuilder {
29        crate::operation::get_data_source::builders::GetDataSourceFluentBuilder::new(self.handle.clone())
30    }
31}
aws_sdk_qbusiness/client/get_data_source.rs

aws_sdk_qbusiness/client/
get_data_source.rs
