update_data_source¶
Operation¶
async
¶
update_data_source(input: UpdateDataSourceInput, plugins: list[Plugin] | None = None) -> UpdateDataSourceOutput
Updates an existing Amazon Q Business data source connector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateDataSourceInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateDataSourceOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateDataSourceInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application the data source is attached to.
class-attribute
instance-attribute
¶
configuration: Document | None = None
Provides the configuration information for an Amazon Q Business data source.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.
class-attribute
instance-attribute
¶
description: str | None = None
The description of the data source connector.
class-attribute
instance-attribute
¶
display_name: str | None = None
A name of the data source connector.
class-attribute
instance-attribute
¶
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = None
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index attached to the data source connector.
class-attribute
instance-attribute
¶
media_extraction_configuration: MediaExtractionConfiguration | None = None
The configuration for extracting information from media in documents for your data source.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
class-attribute
instance-attribute
¶
sync_schedule: str | None = None
The chosen update frequency for your data source.
class-attribute
instance-attribute
¶
vpc_configuration: DataSourceVpcConfiguration | None = None
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
Output¶
dataclass
¶
Dataclass for UpdateDataSourceOutput structure.