S3Vectors / Client / update_index_mode

update_index_mode

S3Vectors.Client.update_index_mode(**kwargs)

Updates the mode for an existing vector index. You can set the mode to ENHANCED for any vector index. You can set the mode to CLASSIC only for a vector index in a vector bucket created before September 30, 2026. This operation doesn’t change the default index mode of the vector bucket or the mode of other vector indexes. Specify the vector index by using its Amazon Resource Name (ARN) or both the vector bucket name and vector index name.

Permissions

You must have the s3vectors:UpdateIndexMode permission to use this operation.

See also: AWS API Documentation

Request Syntax

response = client.update_index_mode(
    vectorBucketName='string',
    indexName='string',
    indexArn='string',
    indexMode='CLASSIC'|'ENHANCED'
)
Parameters:

  • vectorBucketName (string) – The name of the vector bucket that contains the vector index.

  • indexName (string) – The name of the vector index to update.

  • indexArn (string) – The Amazon Resource Name (ARN) of the vector index to update.

  • indexMode (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions