Skip to content

UpdateIndexRequest

Source code in docs_src/capo_qbusiness/types/update_index_request.py
class UpdateIndexRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application connected to the index.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the Amazon Q Business index.</p>"""
    display_name: NotRequired["capo_qbusiness.types.application_name.ApplicationName"]
    """<p>The name of the Amazon Q Business index.</p>"""
    description: NotRequired["capo_qbusiness.types.description.Description"]
    """<p>The description of the Amazon Q Business index.</p>"""
    capacity_configuration: NotRequired[
        "capo_qbusiness.types.index_capacity_configuration.IndexCapacityConfiguration"
    ]
    """<p>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.</p>"""
    document_attribute_configurations: NotRequired[
        "capo_qbusiness.types.document_attribute_configurations.DocumentAttributeConfigurations"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>"""

application_id instance-attribute

application_id: ApplicationId

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

capacity_configuration instance-attribute

capacity_configuration: NotRequired[IndexCapacityConfiguration]

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: NotRequired[Description]

The description of the Amazon Q Business index.

display_name instance-attribute

display_name: NotRequired[ApplicationName]

The name of the Amazon Q Business index.

document_attribute_configurations instance-attribute

document_attribute_configurations: NotRequired[DocumentAttributeConfigurations]

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 instance-attribute

index_id: IndexId

The identifier of the Amazon Q Business index.