S3Vectors module#
Index > S3Vectors
Auto-generated documentation for S3Vectors type annotations stubs module types-boto3-s3vectors.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.39.6' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
S3Vectors
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and S3Vectors
.
From PyPI with pip#
Install types-boto3
for S3Vectors
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[s3vectors]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[s3vectors]'
# standalone installation
python -m pip install types-boto3-s3vectors
How to uninstall#
python -m pip uninstall -y types-boto3-s3vectors
Usage#
Code samples can be found in Examples.
S3VectorsClient#
Type annotations and code completion for boto3.client("s3vectors")
as S3VectorsClient
boto3 documentation
# S3VectorsClient usage example
from boto3.session import Session
from types_boto3_s3vectors.client import S3VectorsClient
def get_client() -> S3VectorsClient:
return Session().client("s3vectors")
Paginators#
Type annotations and code completion for paginators
from boto3.client("s3vectors").get_paginator("...")
.
# ListIndexesPaginator usage example
from boto3.session import Session
from types_boto3_s3vectors.paginator import ListIndexesPaginator
def get_list_indexes_paginator() -> ListIndexesPaginator:
return Session().client("s3vectors").get_paginator("list_indexes"))
Literals#
Type annotations for literals used in methods and schema.
# DataTypeType usage example
from types_boto3_s3vectors.literals import DataTypeType
def get_value() -> DataTypeType:
return "float32"
- DataTypeType
- DistanceMetricType
- ListIndexesPaginatorName
- ListVectorBucketsPaginatorName
- ListVectorsPaginatorName
- SseTypeType
- S3VectorsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- EncryptionConfigurationTypeDef
- DeleteIndexInputTypeDef
- DeleteVectorBucketInputTypeDef
- DeleteVectorBucketPolicyInputTypeDef
- DeleteVectorsInputTypeDef
- GetIndexInputTypeDef
- ResponseMetadataTypeDef
- VectorDataOutputTypeDef
- GetVectorBucketInputTypeDef
- GetVectorBucketPolicyInputTypeDef
- GetVectorsInputTypeDef
- IndexSummaryTypeDef
- MetadataConfigurationOutputTypeDef
- PaginatorConfigTypeDef
- ListIndexesInputTypeDef
- ListVectorBucketsInputTypeDef
- VectorBucketSummaryTypeDef
- ListVectorsInputTypeDef
- MetadataConfigurationTypeDef
- PutVectorBucketPolicyInputTypeDef
- VectorDataTypeDef
- CreateVectorBucketInputTypeDef
- VectorBucketTypeDef
- GetVectorBucketPolicyOutputTypeDef
- GetOutputVectorTypeDef
- ListOutputVectorTypeDef
- QueryOutputVectorTypeDef
- ListIndexesOutputTypeDef
- IndexTypeDef
- ListIndexesInputPaginateTypeDef
- ListVectorBucketsInputPaginateTypeDef
- ListVectorsInputPaginateTypeDef
- ListVectorBucketsOutputTypeDef
- MetadataConfigurationUnionTypeDef
- VectorDataUnionTypeDef
- GetVectorBucketOutputTypeDef
- GetVectorsOutputTypeDef
- ListVectorsOutputTypeDef
- QueryVectorsOutputTypeDef
- GetIndexOutputTypeDef
- CreateIndexInputTypeDef
- PutInputVectorTypeDef
- QueryVectorsInputTypeDef
- PutVectorsInputTypeDef