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 the configurations for a data source connector.

Warning

You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.

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 the configurations for a data source connector.

Warning

You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.

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

data_deletion_policy instance-attribute
data_deletion_policy: str | None

The data deletion policy for the data source that you want to update.

data_source_configuration instance-attribute

The connection configuration for the data source that you want to update.

data_source_id instance-attribute
data_source_id: Required[str]

The unique identifier of the data source.

description instance-attribute
description: str | None

Specifies a new description for the data source.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base for the data source.

name instance-attribute
name: Required[str]

Specifies a new name for the data source.

server_side_encryption_configuration instance-attribute
server_side_encryption_configuration: ServerSideEncryptionConfiguration | ServerSideEncryptionConfigurationDict | None

Contains details about server-side encryption of the data source.

vector_ingestion_configuration instance-attribute
vector_ingestion_configuration: VectorIngestionConfiguration | VectorIngestionConfigurationDict | None

Contains details about how to ingest the documents in the data source.

UpdateDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataSourceInput structure.

Attributes

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

The data deletion policy for the data source that you want to update.

data_source_configuration class-attribute instance-attribute
data_source_configuration: DataSourceConfiguration | None = ...

The connection configuration for the data source that you want to update.

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

The unique identifier of the data source.

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

Specifies a new description for the data source.

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

The unique identifier of the knowledge base for the data source.

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

Specifies a new name for the data source.

server_side_encryption_configuration class-attribute instance-attribute
server_side_encryption_configuration: ServerSideEncryptionConfiguration | None = ...

Contains details about server-side encryption of the data source.

vector_ingestion_configuration class-attribute instance-attribute
vector_ingestion_configuration: VectorIngestionConfiguration | None = ...

Contains details about how to ingest the documents in the data source.

Output

UpdateDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataSourceOutput structure.

Attributes

data_source instance-attribute
data_source: DataSource

Contains details about the data source.

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.