Skip to content

iter_list_vectors

iter_list_vectors(
    *,
    config_overrides: Optional[S3VectorsClientConfig] = None,
    vector_bucket_name: Optional[VectorBucketName] = None,
    index_name: Optional[IndexName] = None,
    index_arn: Optional[IndexArn] = None,
    max_results: Optional[ListVectorsMaxResults] = None,
    next_token: Optional[ListVectorsNextToken] = None,
    segment_count: Optional[ListVectorsSegmentCount] = None,
    segment_index: Optional[ListVectorsSegmentIndex] = None,
    return_data: Optional[bool] = None,
    return_metadata: Optional[bool] = None,
) -> Iterator[ListOutputVector]
Source code in docs_src/capo_s3vectors/_services/s3_vectors.py
def iter_list_vectors(
    self,
    *,
    config_overrides: Optional[S3VectorsClientConfig] = None,
    vector_bucket_name: Optional[
        "capo_s3vectors.types.vector_bucket_name.VectorBucketName"
    ] = None,
    index_name: Optional["capo_s3vectors.types.index_name.IndexName"] = None,
    index_arn: Optional["capo_s3vectors.types.index_arn.IndexArn"] = None,
    max_results: Optional[
        "capo_s3vectors.types.list_vectors_max_results.ListVectorsMaxResults"
    ] = None,
    next_token: Optional[
        "capo_s3vectors.types.list_vectors_next_token.ListVectorsNextToken"
    ] = None,
    segment_count: Optional[
        "capo_s3vectors.types.list_vectors_segment_count.ListVectorsSegmentCount"
    ] = None,
    segment_index: Optional[
        "capo_s3vectors.types.list_vectors_segment_index.ListVectorsSegmentIndex"
    ] = None,
    return_data: Optional[bool] = None,
    return_metadata: Optional[bool] = None,
) -> "Iterator[capo_s3vectors.types.list_output_vector.ListOutputVector]":
    _token = next_token
    while True:
        _response = self.list_vectors(
            config_overrides=config_overrides,
            vector_bucket_name=vector_bucket_name,
            index_name=index_name,
            index_arn=index_arn,
            max_results=max_results,
            next_token=_token,
            segment_count=segment_count,
            segment_index=segment_index,
            return_data=return_data,
            return_metadata=return_metadata,
        )
        _page = _resolve_path(_response, ("vectors",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break