Skip to content

GetIndexInput

Source code in docs_src/capo_s3vectors/types/get_index_input.py
class GetIndexInput(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.</p>"""
    index_arn: NotRequired["capo_s3vectors.types.index_arn.IndexArn"]
    """<p>The ARN of the vector index.</p>"""

index_arn instance-attribute

index_arn: NotRequired[IndexArn]

The ARN of the vector index.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the vector index.

vector_bucket_name instance-attribute

vector_bucket_name: NotRequired[VectorBucketName]

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