Skip to content

Type definitions#

Index > S3Vectors > Type definitions

Auto-generated documentation for S3Vectors type annotations stubs module mypy-boto3-s3vectors.

MetadataConfigurationUnionTypeDef#

# MetadataConfigurationUnionTypeDef Union usage example

from mypy_boto3_s3vectors.type_defs import MetadataConfigurationUnionTypeDef


def get_value() -> MetadataConfigurationUnionTypeDef:
    return ...


# MetadataConfigurationUnionTypeDef definition

MetadataConfigurationUnionTypeDef = Union[
    MetadataConfigurationTypeDef,  # (1)
    MetadataConfigurationOutputTypeDef,  # (2)
]
  1. See MetadataConfigurationTypeDef
  2. See MetadataConfigurationOutputTypeDef

VectorDataUnionTypeDef#

# VectorDataUnionTypeDef Union usage example

from mypy_boto3_s3vectors.type_defs import VectorDataUnionTypeDef


def get_value() -> VectorDataUnionTypeDef:
    return ...


# VectorDataUnionTypeDef definition

VectorDataUnionTypeDef = Union[
    VectorDataTypeDef,  # (1)
    VectorDataOutputTypeDef,  # (2)
]
  1. See VectorDataTypeDef
  2. See VectorDataOutputTypeDef

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import EncryptionConfigurationTypeDef


def get_value() -> EncryptionConfigurationTypeDef:
    return {
        "sseType": ...,
    }


# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    sseType: NotRequired[SseTypeType],  # (1)
    kmsKeyArn: NotRequired[str],
  1. See SseTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteIndexInputTypeDef#

# DeleteIndexInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import DeleteIndexInputTypeDef


def get_value() -> DeleteIndexInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# DeleteIndexInputTypeDef definition

class DeleteIndexInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],

DeleteVectorBucketInputTypeDef#

# DeleteVectorBucketInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import DeleteVectorBucketInputTypeDef


def get_value() -> DeleteVectorBucketInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# DeleteVectorBucketInputTypeDef definition

class DeleteVectorBucketInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],

DeleteVectorBucketPolicyInputTypeDef#

# DeleteVectorBucketPolicyInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import DeleteVectorBucketPolicyInputTypeDef


def get_value() -> DeleteVectorBucketPolicyInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# DeleteVectorBucketPolicyInputTypeDef definition

class DeleteVectorBucketPolicyInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],

DeleteVectorsInputTypeDef#

# DeleteVectorsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import DeleteVectorsInputTypeDef


def get_value() -> DeleteVectorsInputTypeDef:
    return {
        "keys": ...,
    }


# DeleteVectorsInputTypeDef definition

class DeleteVectorsInputTypeDef(TypedDict):
    keys: Sequence[str],
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],

GetIndexInputTypeDef#

# GetIndexInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetIndexInputTypeDef


def get_value() -> GetIndexInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# GetIndexInputTypeDef definition

class GetIndexInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],

VectorDataOutputTypeDef#

# VectorDataOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import VectorDataOutputTypeDef


def get_value() -> VectorDataOutputTypeDef:
    return {
        "float32": ...,
    }


# VectorDataOutputTypeDef definition

class VectorDataOutputTypeDef(TypedDict):
    float32: NotRequired[list[float]],

GetVectorBucketInputTypeDef#

# GetVectorBucketInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorBucketInputTypeDef


def get_value() -> GetVectorBucketInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# GetVectorBucketInputTypeDef definition

class GetVectorBucketInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],

GetVectorBucketPolicyInputTypeDef#

# GetVectorBucketPolicyInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorBucketPolicyInputTypeDef


def get_value() -> GetVectorBucketPolicyInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# GetVectorBucketPolicyInputTypeDef definition

class GetVectorBucketPolicyInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],

GetVectorsInputTypeDef#

# GetVectorsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorsInputTypeDef


def get_value() -> GetVectorsInputTypeDef:
    return {
        "keys": ...,
    }


# GetVectorsInputTypeDef definition

class GetVectorsInputTypeDef(TypedDict):
    keys: Sequence[str],
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],
    returnData: NotRequired[bool],
    returnMetadata: NotRequired[bool],

IndexSummaryTypeDef#

# IndexSummaryTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import IndexSummaryTypeDef


def get_value() -> IndexSummaryTypeDef:
    return {
        "vectorBucketName": ...,
    }


# IndexSummaryTypeDef definition

class IndexSummaryTypeDef(TypedDict):
    vectorBucketName: str,
    indexName: str,
    indexArn: str,
    creationTime: datetime.datetime,

MetadataConfigurationOutputTypeDef#

# MetadataConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import MetadataConfigurationOutputTypeDef


def get_value() -> MetadataConfigurationOutputTypeDef:
    return {
        "nonFilterableMetadataKeys": ...,
    }


# MetadataConfigurationOutputTypeDef definition

class MetadataConfigurationOutputTypeDef(TypedDict):
    nonFilterableMetadataKeys: list[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListIndexesInputTypeDef#

# ListIndexesInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListIndexesInputTypeDef


def get_value() -> ListIndexesInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# ListIndexesInputTypeDef definition

class ListIndexesInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    prefix: NotRequired[str],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    resourceArn: str,

ListVectorBucketsInputTypeDef#

# ListVectorBucketsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorBucketsInputTypeDef


def get_value() -> ListVectorBucketsInputTypeDef:
    return {
        "maxResults": ...,
    }


# ListVectorBucketsInputTypeDef definition

class ListVectorBucketsInputTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    prefix: NotRequired[str],

VectorBucketSummaryTypeDef#

# VectorBucketSummaryTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import VectorBucketSummaryTypeDef


def get_value() -> VectorBucketSummaryTypeDef:
    return {
        "vectorBucketName": ...,
    }


# VectorBucketSummaryTypeDef definition

class VectorBucketSummaryTypeDef(TypedDict):
    vectorBucketName: str,
    vectorBucketArn: str,
    creationTime: datetime.datetime,

ListVectorsInputTypeDef#

# ListVectorsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorsInputTypeDef


def get_value() -> ListVectorsInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# ListVectorsInputTypeDef definition

class ListVectorsInputTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    segmentCount: NotRequired[int],
    segmentIndex: NotRequired[int],
    returnData: NotRequired[bool],
    returnMetadata: NotRequired[bool],

MetadataConfigurationTypeDef#

# MetadataConfigurationTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import MetadataConfigurationTypeDef


def get_value() -> MetadataConfigurationTypeDef:
    return {
        "nonFilterableMetadataKeys": ...,
    }


# MetadataConfigurationTypeDef definition

class MetadataConfigurationTypeDef(TypedDict):
    nonFilterableMetadataKeys: Sequence[str],

PutVectorBucketPolicyInputTypeDef#

# PutVectorBucketPolicyInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import PutVectorBucketPolicyInputTypeDef


def get_value() -> PutVectorBucketPolicyInputTypeDef:
    return {
        "policy": ...,
    }


# PutVectorBucketPolicyInputTypeDef definition

class PutVectorBucketPolicyInputTypeDef(TypedDict):
    policy: str,
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],

QueryOutputVectorTypeDef#

# QueryOutputVectorTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import QueryOutputVectorTypeDef


def get_value() -> QueryOutputVectorTypeDef:
    return {
        "distance": ...,
    }


# QueryOutputVectorTypeDef definition

class QueryOutputVectorTypeDef(TypedDict):
    key: str,
    distance: NotRequired[float],
    metadata: NotRequired[dict[str, Any]],

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

VectorDataTypeDef#

# VectorDataTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import VectorDataTypeDef


def get_value() -> VectorDataTypeDef:
    return {
        "float32": ...,
    }


# VectorDataTypeDef definition

class VectorDataTypeDef(TypedDict):
    float32: NotRequired[Sequence[float]],

CreateVectorBucketInputTypeDef#

# CreateVectorBucketInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import CreateVectorBucketInputTypeDef


def get_value() -> CreateVectorBucketInputTypeDef:
    return {
        "vectorBucketName": ...,
    }


# CreateVectorBucketInputTypeDef definition

class CreateVectorBucketInputTypeDef(TypedDict):
    vectorBucketName: str,
    encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See EncryptionConfigurationTypeDef

VectorBucketTypeDef#

# VectorBucketTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import VectorBucketTypeDef


def get_value() -> VectorBucketTypeDef:
    return {
        "vectorBucketName": ...,
    }


# VectorBucketTypeDef definition

class VectorBucketTypeDef(TypedDict):
    vectorBucketName: str,
    vectorBucketArn: str,
    creationTime: datetime.datetime,
    encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
  1. See EncryptionConfigurationTypeDef

CreateIndexOutputTypeDef#

# CreateIndexOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import CreateIndexOutputTypeDef


def get_value() -> CreateIndexOutputTypeDef:
    return {
        "indexArn": ...,
    }


# CreateIndexOutputTypeDef definition

class CreateIndexOutputTypeDef(TypedDict):
    indexArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateVectorBucketOutputTypeDef#

# CreateVectorBucketOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import CreateVectorBucketOutputTypeDef


def get_value() -> CreateVectorBucketOutputTypeDef:
    return {
        "vectorBucketArn": ...,
    }


# CreateVectorBucketOutputTypeDef definition

class CreateVectorBucketOutputTypeDef(TypedDict):
    vectorBucketArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetVectorBucketPolicyOutputTypeDef#

# GetVectorBucketPolicyOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorBucketPolicyOutputTypeDef


def get_value() -> GetVectorBucketPolicyOutputTypeDef:
    return {
        "policy": ...,
    }


# GetVectorBucketPolicyOutputTypeDef definition

class GetVectorBucketPolicyOutputTypeDef(TypedDict):
    policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetOutputVectorTypeDef#

# GetOutputVectorTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetOutputVectorTypeDef


def get_value() -> GetOutputVectorTypeDef:
    return {
        "key": ...,
    }


# GetOutputVectorTypeDef definition

class GetOutputVectorTypeDef(TypedDict):
    key: str,
    data: NotRequired[VectorDataOutputTypeDef],  # (1)
    metadata: NotRequired[dict[str, Any]],
  1. See VectorDataOutputTypeDef

ListOutputVectorTypeDef#

# ListOutputVectorTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListOutputVectorTypeDef


def get_value() -> ListOutputVectorTypeDef:
    return {
        "key": ...,
    }


# ListOutputVectorTypeDef definition

class ListOutputVectorTypeDef(TypedDict):
    key: str,
    data: NotRequired[VectorDataOutputTypeDef],  # (1)
    metadata: NotRequired[dict[str, Any]],
  1. See VectorDataOutputTypeDef

ListIndexesOutputTypeDef#

# ListIndexesOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListIndexesOutputTypeDef


def get_value() -> ListIndexesOutputTypeDef:
    return {
        "nextToken": ...,
    }


# ListIndexesOutputTypeDef definition

class ListIndexesOutputTypeDef(TypedDict):
    indexes: list[IndexSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[IndexSummaryTypeDef]
  2. See ResponseMetadataTypeDef

IndexTypeDef#

# IndexTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import IndexTypeDef


def get_value() -> IndexTypeDef:
    return {
        "vectorBucketName": ...,
    }


# IndexTypeDef definition

class IndexTypeDef(TypedDict):
    vectorBucketName: str,
    indexName: str,
    indexArn: str,
    creationTime: datetime.datetime,
    dataType: DataTypeType,  # (1)
    dimension: int,
    distanceMetric: DistanceMetricType,  # (2)
    metadataConfiguration: NotRequired[MetadataConfigurationOutputTypeDef],  # (3)
    encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (4)
  1. See DataTypeType
  2. See DistanceMetricType
  3. See MetadataConfigurationOutputTypeDef
  4. See EncryptionConfigurationTypeDef

ListIndexesInputPaginateTypeDef#

# ListIndexesInputPaginateTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListIndexesInputPaginateTypeDef


def get_value() -> ListIndexesInputPaginateTypeDef:
    return {
        "vectorBucketName": ...,
    }


# ListIndexesInputPaginateTypeDef definition

class ListIndexesInputPaginateTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVectorBucketsInputPaginateTypeDef#

# ListVectorBucketsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorBucketsInputPaginateTypeDef


def get_value() -> ListVectorBucketsInputPaginateTypeDef:
    return {
        "prefix": ...,
    }


# ListVectorBucketsInputPaginateTypeDef definition

class ListVectorBucketsInputPaginateTypeDef(TypedDict):
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVectorsInputPaginateTypeDef#

# ListVectorsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorsInputPaginateTypeDef


def get_value() -> ListVectorsInputPaginateTypeDef:
    return {
        "vectorBucketName": ...,
    }


# ListVectorsInputPaginateTypeDef definition

class ListVectorsInputPaginateTypeDef(TypedDict):
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],
    segmentCount: NotRequired[int],
    segmentIndex: NotRequired[int],
    returnData: NotRequired[bool],
    returnMetadata: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVectorBucketsOutputTypeDef#

# ListVectorBucketsOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorBucketsOutputTypeDef


def get_value() -> ListVectorBucketsOutputTypeDef:
    return {
        "nextToken": ...,
    }


# ListVectorBucketsOutputTypeDef definition

class ListVectorBucketsOutputTypeDef(TypedDict):
    vectorBuckets: list[VectorBucketSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[VectorBucketSummaryTypeDef]
  2. See ResponseMetadataTypeDef

QueryVectorsOutputTypeDef#

# QueryVectorsOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import QueryVectorsOutputTypeDef


def get_value() -> QueryVectorsOutputTypeDef:
    return {
        "vectors": ...,
    }


# QueryVectorsOutputTypeDef definition

class QueryVectorsOutputTypeDef(TypedDict):
    vectors: list[QueryOutputVectorTypeDef],  # (1)
    distanceMetric: DistanceMetricType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See list[QueryOutputVectorTypeDef]
  2. See DistanceMetricType
  3. See ResponseMetadataTypeDef

GetVectorBucketOutputTypeDef#

# GetVectorBucketOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorBucketOutputTypeDef


def get_value() -> GetVectorBucketOutputTypeDef:
    return {
        "vectorBucket": ...,
    }


# GetVectorBucketOutputTypeDef definition

class GetVectorBucketOutputTypeDef(TypedDict):
    vectorBucket: VectorBucketTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VectorBucketTypeDef
  2. See ResponseMetadataTypeDef

GetVectorsOutputTypeDef#

# GetVectorsOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetVectorsOutputTypeDef


def get_value() -> GetVectorsOutputTypeDef:
    return {
        "vectors": ...,
    }


# GetVectorsOutputTypeDef definition

class GetVectorsOutputTypeDef(TypedDict):
    vectors: list[GetOutputVectorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[GetOutputVectorTypeDef]
  2. See ResponseMetadataTypeDef

ListVectorsOutputTypeDef#

# ListVectorsOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import ListVectorsOutputTypeDef


def get_value() -> ListVectorsOutputTypeDef:
    return {
        "nextToken": ...,
    }


# ListVectorsOutputTypeDef definition

class ListVectorsOutputTypeDef(TypedDict):
    vectors: list[ListOutputVectorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[ListOutputVectorTypeDef]
  2. See ResponseMetadataTypeDef

GetIndexOutputTypeDef#

# GetIndexOutputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import GetIndexOutputTypeDef


def get_value() -> GetIndexOutputTypeDef:
    return {
        "index": ...,
    }


# GetIndexOutputTypeDef definition

class GetIndexOutputTypeDef(TypedDict):
    index: IndexTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexTypeDef
  2. See ResponseMetadataTypeDef

CreateIndexInputTypeDef#

# CreateIndexInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import CreateIndexInputTypeDef


def get_value() -> CreateIndexInputTypeDef:
    return {
        "indexName": ...,
    }


# CreateIndexInputTypeDef definition

class CreateIndexInputTypeDef(TypedDict):
    indexName: str,
    dataType: DataTypeType,  # (1)
    dimension: int,
    distanceMetric: DistanceMetricType,  # (2)
    vectorBucketName: NotRequired[str],
    vectorBucketArn: NotRequired[str],
    metadataConfiguration: NotRequired[MetadataConfigurationUnionTypeDef],  # (3)
    encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (4)
    tags: NotRequired[Mapping[str, str]],
  1. See DataTypeType
  2. See DistanceMetricType
  3. See MetadataConfigurationUnionTypeDef
  4. See EncryptionConfigurationTypeDef

PutInputVectorTypeDef#

# PutInputVectorTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import PutInputVectorTypeDef


def get_value() -> PutInputVectorTypeDef:
    return {
        "key": ...,
    }


# PutInputVectorTypeDef definition

class PutInputVectorTypeDef(TypedDict):
    key: str,
    data: VectorDataUnionTypeDef,  # (1)
    metadata: NotRequired[Mapping[str, Any]],
  1. See VectorDataUnionTypeDef

QueryVectorsInputTypeDef#

# QueryVectorsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import QueryVectorsInputTypeDef


def get_value() -> QueryVectorsInputTypeDef:
    return {
        "topK": ...,
    }


# QueryVectorsInputTypeDef definition

class QueryVectorsInputTypeDef(TypedDict):
    topK: int,
    queryVector: VectorDataUnionTypeDef,  # (1)
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],
    filter: NotRequired[Mapping[str, Any]],
    returnMetadata: NotRequired[bool],
    returnDistance: NotRequired[bool],
  1. See VectorDataUnionTypeDef

PutVectorsInputTypeDef#

# PutVectorsInputTypeDef TypedDict usage example

from mypy_boto3_s3vectors.type_defs import PutVectorsInputTypeDef


def get_value() -> PutVectorsInputTypeDef:
    return {
        "vectors": ...,
    }


# PutVectorsInputTypeDef definition

class PutVectorsInputTypeDef(TypedDict):
    vectors: Sequence[PutInputVectorTypeDef],  # (1)
    vectorBucketName: NotRequired[str],
    indexName: NotRequired[str],
    indexArn: NotRequired[str],
  1. See Sequence[PutInputVectorTypeDef]