S3Vectors / Client / put_vector_bucket_default_index_mode

put_vector_bucket_default_index_mode

S3Vectors.Client.put_vector_bucket_default_index_mode(**kwargs)

Updates the default index mode for a vector bucket. The updated default applies to vector indexes that you create after the request succeeds. The operation doesn’t change existing vector indexes. To specify the vector bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.put_vector_bucket_default_index_mode(
    vectorBucketName='string',
    vectorBucketArn='string',
    defaultIndexMode='CLASSIC'|'ENHANCED'
)
Parameters:

  • vectorBucketName (string) – The name of the vector bucket to update.

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

  • defaultIndexMode (string) –

    [REQUIRED]

    The default mode to assign to new vector indexes in the vector bucket. This change doesn’t affect existing vector indexes.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • S3Vectors.Client.exceptions.ValidationException

  • S3Vectors.Client.exceptions.ServiceUnavailableException

  • S3Vectors.Client.exceptions.TooManyRequestsException

  • S3Vectors.Client.exceptions.InternalServerException

  • S3Vectors.Client.exceptions.AccessDeniedException

  • S3Vectors.Client.exceptions.RequestTimeoutException

  • S3Vectors.Client.exceptions.NotFoundException