CreateIndexInput ¶

class CreateIndexInput(TypedDict, closed=True):
    vector_bucket_name: NotRequired[
        "capo_s3vectors.types.vector_bucket_name.VectorBucketName"
    ]
    """<p>The name of the vector bucket to create the vector index in. </p>"""
    vector_bucket_arn: NotRequired[
        "capo_s3vectors.types.vector_bucket_arn.VectorBucketArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.</p>"""
    index_name: "capo_s3vectors.types.index_name.IndexName"
    """<p>The name of the vector index to create. </p>"""
    data_type: "capo_s3vectors.types.data_type.DataType"
    """<p>The data type of the vectors to be inserted into the vector index. </p>"""
    dimension: "capo_s3vectors.types.dimension.Dimension"
    """<p>The dimensions of the vectors to be inserted into the vector index. </p>"""
    distance_metric: "capo_s3vectors.types.distance_metric.DistanceMetric"
    """<p>The distance metric to be used for similarity search. </p>"""
    metadata_configuration: NotRequired[
        "capo_s3vectors.types.metadata_configuration.MetadataConfiguration"
    ]
    """<p>The metadata configuration for the vector index. </p>"""
    encryption_configuration: NotRequired[
        "capo_s3vectors.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.</p>"""
    tags: NotRequired["capo_s3vectors.types.tags_map.TagsMap"]
    """<p>An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateIndex</code> permission to create a vector index with tags.</p> </note>"""