Skip to content

update_data_source

Operation

update_data_source

update_data_source(request: UpdateDataSourceInput | UpdateDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDataSourceInputDict]) -> UpdateDataSourceOutput

Updates an existing Amazon Q Business data source connector.

Parameters:

Name Type Description Default
request UpdateDataSourceInput | UpdateDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDataSourceOutput

An instance of UpdateDataSourceOutput.

update_data_source async

update_data_source(request: UpdateDataSourceInput | UpdateDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDataSourceInputDict]) -> UpdateDataSourceOutput

Updates an existing Amazon Q Business data source connector.

Parameters:

Name Type Description Default
request UpdateDataSourceInput | UpdateDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDataSourceOutput

An instance of UpdateDataSourceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateDataSourceInputDict

Bases: TypedDict

Dictionary form of UpdateDataSourceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application the data source is attached to.

configuration instance-attribute
configuration: Document | None

Provides the configuration information for an Amazon Q Business data source.

data_source_id instance-attribute
data_source_id: Required[str]

The identifier of the data source connector.

description instance-attribute
description: str | None

The description of the data source connector.

display_name instance-attribute
display_name: str | None

A name of the data source connector.

document_enrichment_configuration instance-attribute
document_enrichment_configuration: DocumentEnrichmentConfiguration | DocumentEnrichmentConfigurationDict | None

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

index_id instance-attribute
index_id: Required[str]

The identifier of the index attached to the data source connector.

media_extraction_configuration instance-attribute
media_extraction_configuration: MediaExtractionConfiguration | MediaExtractionConfigurationDict | None

The configuration for extracting information from media in documents for your data source.

role_arn instance-attribute
role_arn: str | None

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

sync_schedule instance-attribute
sync_schedule: str | None

The chosen update frequency for your data source.

vpc_configuration instance-attribute

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

UpdateDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataSourceInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application the data source is attached to.

configuration class-attribute instance-attribute
configuration: Document | None = ...

Provides the configuration information for an Amazon Q Business data source.

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The identifier of the data source connector.

description class-attribute instance-attribute
description: str | None = ...

The description of the data source connector.

display_name class-attribute instance-attribute
display_name: str | None = ...

A name of the data source connector.

document_enrichment_configuration class-attribute instance-attribute
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = ...

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

index_id class-attribute instance-attribute
index_id: str | None = ...

The identifier of the index attached to the data source connector.

media_extraction_configuration class-attribute instance-attribute
media_extraction_configuration: MediaExtractionConfiguration | None = ...

The configuration for extracting information from media in documents for your data source.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

sync_schedule class-attribute instance-attribute
sync_schedule: str | None = ...

The chosen update frequency for your data source.

vpc_configuration class-attribute instance-attribute
vpc_configuration: DataSourceVpcConfiguration | None = ...

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

Output

UpdateDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataSourceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.