Examples

Index > S3Vectors > Examples

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

Client

Implicit type annotations

Can be used with boto3-stubs[s3vectors] package installed.

Write your S3Vectors code as usual, type checking and code completion should work out of the box.

Client method usage example

# S3VectorsClient usage example

from boto3.session import Session


session = Session()

client = session.client("s3vectors")  # (1)
result = client.get_index()  # (2)

1. client: S3VectorsClient
2. result: GetIndexOutputTypeDef

Paginator usage example

# ListIndexesPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("s3vectors")  # (1)

paginator = client.get_paginator("list_indexes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: S3VectorsClient
2. paginator: ListIndexesPaginator
3. item: ListIndexesOutputTypeDef

Explicit type annotations

With boto3-stubs-lite[s3vectors] or a standalone mypy_boto3_s3vectors package, you have to explicitly specify client: S3VectorsClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# S3VectorsClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3vectors.client import S3VectorsClient
from mypy_boto3_s3vectors.type_defs import GetIndexOutputTypeDef
from mypy_boto3_s3vectors.type_defs import GetIndexInputTypeDef


session = Session()

client: S3VectorsClient = session.client("s3vectors")

kwargs: GetIndexInputTypeDef = {...}
result: GetIndexOutputTypeDef = client.get_index(**kwargs)

Paginator usage example

# ListIndexesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3vectors.client import S3VectorsClient
from mypy_boto3_s3vectors.paginator import ListIndexesPaginator
from mypy_boto3_s3vectors.type_defs import ListIndexesOutputTypeDef


session = Session()
client: S3VectorsClient = session.client("s3vectors")

paginator: ListIndexesPaginator = client.get_paginator("list_indexes")
for item in paginator.paginate(...):
    item: ListIndexesOutputTypeDef
    print(item)