Skip to content

UpdateIndexRequest

Source code in docs_src/capo_opensearchserverless/types/update_index_request.py
class UpdateIndexRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.collection_id.CollectionId"
    """<p>The unique identifier of the collection containing the index to update.</p>"""
    index_name: "capo_opensearchserverless.types.index_name.IndexName"
    """<p>The name of the index to update.</p>"""
    index_schema: NotRequired[
        "capo_opensearchserverless.types.index_schema.IndexSchema"
    ]
    """<p>The updated JSON schema definition for the index, including field mappings and settings. </p>"""

id instance-attribute

The unique identifier of the collection containing the index to update.

index_name instance-attribute

index_name: IndexName

The name of the index to update.

index_schema instance-attribute

index_schema: NotRequired[IndexSchema]

The updated JSON schema definition for the index, including field mappings and settings.