Skip to content

UpdateIndexModeInput

Source code in docs_src/capo_s3vectors/types/update_index_mode_input.py
class UpdateIndexModeInput(TypedDict, closed=True):
    vector_bucket_name: NotRequired[
        "capo_s3vectors.types.vector_bucket_name.VectorBucketName"
    ]
    """<p>The name of the vector bucket that contains the vector index.</p>"""
    index_name: NotRequired["capo_s3vectors.types.index_name.IndexName"]
    """<p>The name of the vector index to update.</p>"""
    index_arn: NotRequired["capo_s3vectors.types.index_arn.IndexArn"]
    """<p>The Amazon Resource Name (ARN) of the vector index to update.</p>"""
    index_mode: "capo_s3vectors.types.index_mode.IndexMode"
    """<p>The new mode for the vector index.</p> <p>Valid values:</p> <ul> <li> <p> <code>CLASSIC</code> - Applies metadata filters during the vector search. You can specify <code>CLASSIC</code> only for a vector index in a vector bucket created before September 30, 2026.</p> </li> <li> <p> <code>ENHANCED</code> - Applies metadata filters before the vector search.</p> </li> </ul>"""

index_arn instance-attribute

index_arn: NotRequired[IndexArn]

The Amazon Resource Name (ARN) of the vector index to update.

index_mode instance-attribute

index_mode: IndexMode

The new mode for the vector index.

Valid values:

  • CLASSIC - Applies metadata filters during the vector search. You can specify CLASSIC only for a vector index in a vector bucket created before September 30, 2026.

  • ENHANCED - Applies metadata filters before the vector search.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the vector index to update.

vector_bucket_name instance-attribute

vector_bucket_name: NotRequired[VectorBucketName]

The name of the vector bucket that contains the vector index.