update_index¶
Operation¶
update_index
¶
update_index(request: UpdateIndexInput | UpdateIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateIndexInputDict]) -> UpdateIndexOutput
Updates an Amazon Q Business index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateIndexInput | UpdateIndexInputDict | 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[UpdateIndexInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateIndexOutput
|
An instance of |
update_index
async
¶
update_index(request: UpdateIndexInput | UpdateIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateIndexInputDict]) -> UpdateIndexOutput
Updates an Amazon Q Business index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateIndexInput | UpdateIndexInputDict | 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[UpdateIndexInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateIndexOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateIndexInputDict
¶
Bases: TypedDict
Dictionary form of UpdateIndexInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the Amazon Q Business application connected to the index.
capacity_configuration
instance-attribute
¶
capacity_configuration: IndexCapacityConfiguration | IndexCapacityConfigurationDict | 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
instance-attribute
¶
description: str | None
The description of the Amazon Q Business index.
document_attribute_configurations
instance-attribute
¶
document_attribute_configurations: Sequence[DocumentAttributeConfiguration | DocumentAttributeConfigurationDict] | 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.
UpdateIndexInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateIndexInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application connected to the index.
capacity_configuration
class-attribute
instance-attribute
¶
capacity_configuration: IndexCapacityConfiguration | 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 = ...
The description of the Amazon Q Business index.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The name of the Amazon Q Business index.
document_attribute_configurations
class-attribute
instance-attribute
¶
document_attribute_configurations: list[DocumentAttributeConfiguration] | 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.
Output¶
UpdateIndexOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateIndexOutput structure.