Qbusiness  >  Operations  >  update_index

update_index

Operation

update_index async

update_index(input: UpdateIndexInput, plugins: list[Plugin] | None = None) -> UpdateIndexOutput

Updates an Amazon Q Business index.

Parameters:

Name	Type	Description	Default
input	UpdateIndexInput	An instance of UpdateIndexInput.	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
UpdateIndexOutput	An instance of UpdateIndexOutput.

Input

UpdateIndexInput dataclass

Dataclass for UpdateIndexInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the Amazon Q Business application connected to the index.

capacity_configuration class-attribute instance-attribute

capacity_configuration: IndexCapacityConfiguration | None = None

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

description class-attribute instance-attribute

description: str | None = None

The description of the Amazon Q Business index.

display_name class-attribute instance-attribute

display_name: str | None = None

The name of the Amazon Q Business index.

document_attribute_configurations class-attribute instance-attribute

document_attribute_configurations: list[DocumentAttributeConfiguration] | None = None

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier of the Amazon Q Business index.

Output

UpdateIndexOutput dataclass

Dataclass for UpdateIndexOutput structure.