Paginators

Index > S3Vectors > Paginators

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

ListIndexesPaginator

Type annotations and code completion for boto3.client("s3vectors").get_paginator("list_indexes"). boto3 documentation

# ListIndexesPaginator usage example

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListIndexesPaginator

def get_list_indexes_paginator() -> ListIndexesPaginator:
    return Session().client("s3vectors").get_paginator("list_indexes")

# ListIndexesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListIndexesPaginator

session = Session()

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

1. client: S3VectorsClient
2. paginator: ListIndexesPaginator
3. item: PageIterator[ListIndexesOutputTypeDef]

paginate

Type annotations and code completion for ListIndexesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    vectorBucketName: str = ...,
    vectorBucketArn: str = ...,
    prefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListIndexesOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListIndexesOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListIndexesInputPaginateTypeDef = {  # (1)
    "vectorBucketName": ...,
}

parent.paginate(**kwargs)

1. See ListIndexesInputPaginateTypeDef

ListVectorBucketsPaginator

Type annotations and code completion for boto3.client("s3vectors").get_paginator("list_vector_buckets"). boto3 documentation

# ListVectorBucketsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListVectorBucketsPaginator

def get_list_vector_buckets_paginator() -> ListVectorBucketsPaginator:
    return Session().client("s3vectors").get_paginator("list_vector_buckets")

# ListVectorBucketsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListVectorBucketsPaginator

session = Session()

client = Session().client("s3vectors")  # (1)
paginator: ListVectorBucketsPaginator = client.get_paginator("list_vector_buckets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: S3VectorsClient
2. paginator: ListVectorBucketsPaginator
3. item: PageIterator[ListVectorBucketsOutputTypeDef]

paginate

Type annotations and code completion for ListVectorBucketsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    prefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListVectorBucketsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListVectorBucketsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListVectorBucketsInputPaginateTypeDef = {  # (1)
    "prefix": ...,
}

parent.paginate(**kwargs)

1. See ListVectorBucketsInputPaginateTypeDef

ListVectorsPaginator

Type annotations and code completion for boto3.client("s3vectors").get_paginator("list_vectors"). boto3 documentation

# ListVectorsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListVectorsPaginator

def get_list_vectors_paginator() -> ListVectorsPaginator:
    return Session().client("s3vectors").get_paginator("list_vectors")

# ListVectorsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_s3vectors.paginator import ListVectorsPaginator

session = Session()

client = Session().client("s3vectors")  # (1)
paginator: ListVectorsPaginator = client.get_paginator("list_vectors")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: S3VectorsClient
2. paginator: ListVectorsPaginator
3. item: PageIterator[ListVectorsOutputTypeDef]

paginate

Type annotations and code completion for ListVectorsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    vectorBucketName: str = ...,
    indexName: str = ...,
    indexArn: str = ...,
    segmentCount: int = ...,
    segmentIndex: int = ...,
    returnData: bool = ...,
    returnMetadata: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListVectorsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListVectorsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListVectorsInputPaginateTypeDef = {  # (1)
    "vectorBucketName": ...,
}

parent.paginate(**kwargs)

1. See ListVectorsInputPaginateTypeDef