Skip to content

GetVectorsInput

Source code in docs_src/capo_s3vectors/types/get_vectors_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class GetVectorsInput(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>"""
    keys: "capo_s3vectors.types.get_vectors_input_list.GetVectorsInputList"
    """<p>The names of the vectors you want to return attributes for. </p>"""
    return_data: "bool"
    """<p>Indicates whether to include the vector data in the response. The default value is <code>false</code>.</p>"""
    return_metadata: "bool"
    """<p>Indicates whether to include metadata in the response. The default value is <code>false</code>.</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.

keys instance-attribute 

keys: GetVectorsInputList

The names of the vectors you want to return attributes for.

return_data instance-attribute 

return_data: bool

Indicates whether to include the vector data in the response. The default value is false.

return_metadata instance-attribute 

return_metadata: bool

Indicates whether to include metadata in the response. The default value is false.

vector_bucket_name instance-attribute 

vector_bucket_name: NotRequired[VectorBucketName]

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