mypy-boto3-s3vectors 1.39.5__py3-none-any.whl

mypy_boto3_s3vectors/client.pyi

@@ -0,0 +1,310 @@
+"""
+Type annotations for s3vectors service Client.
+
+[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/)
+
+Copyright 2025 Vlad Emelianov
+
+Usage::
+
+    ```python
+    from boto3.session import Session
+    from mypy_boto3_s3vectors.client import S3VectorsClient
+
+    session = Session()
+    client: S3VectorsClient = session.client("s3vectors")
+    ```
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import Any, overload
+
+from botocore.client import BaseClient, ClientMeta
+from botocore.errorfactory import BaseClientExceptions
+from botocore.exceptions import ClientError as BotocoreClientError
+
+from .paginator import ListIndexesPaginator, ListVectorBucketsPaginator, ListVectorsPaginator
+from .type_defs import (
+    CreateIndexInputTypeDef,
+    CreateVectorBucketInputTypeDef,
+    DeleteIndexInputTypeDef,
+    DeleteVectorBucketInputTypeDef,
+    DeleteVectorBucketPolicyInputTypeDef,
+    DeleteVectorsInputTypeDef,
+    GetIndexInputTypeDef,
+    GetIndexOutputTypeDef,
+    GetVectorBucketInputTypeDef,
+    GetVectorBucketOutputTypeDef,
+    GetVectorBucketPolicyInputTypeDef,
+    GetVectorBucketPolicyOutputTypeDef,
+    GetVectorsInputTypeDef,
+    GetVectorsOutputTypeDef,
+    ListIndexesInputTypeDef,
+    ListIndexesOutputTypeDef,
+    ListVectorBucketsInputTypeDef,
+    ListVectorBucketsOutputTypeDef,
+    ListVectorsInputTypeDef,
+    ListVectorsOutputTypeDef,
+    PutVectorBucketPolicyInputTypeDef,
+    PutVectorsInputTypeDef,
+    QueryVectorsInputTypeDef,
+    QueryVectorsOutputTypeDef,
+)
+
+if sys.version_info >= (3, 9):
+    from builtins import dict as Dict
+    from builtins import type as Type
+    from collections.abc import Mapping
+else:
+    from typing import Dict, Mapping, Type
+if sys.version_info >= (3, 12):
+    from typing import Literal, Unpack
+else:
+    from typing_extensions import Literal, Unpack
+
+__all__ = ("S3VectorsClient",)
+
+class Exceptions(BaseClientExceptions):
+    AccessDeniedException: Type[BotocoreClientError]
+    ClientError: Type[BotocoreClientError]
+    ConflictException: Type[BotocoreClientError]
+    InternalServerException: Type[BotocoreClientError]
+    KmsDisabledException: Type[BotocoreClientError]
+    KmsInvalidKeyUsageException: Type[BotocoreClientError]
+    KmsInvalidStateException: Type[BotocoreClientError]
+    KmsNotFoundException: Type[BotocoreClientError]
+    NotFoundException: Type[BotocoreClientError]
+    ServiceQuotaExceededException: Type[BotocoreClientError]
+    ServiceUnavailableException: Type[BotocoreClientError]
+    TooManyRequestsException: Type[BotocoreClientError]
+    ValidationException: Type[BotocoreClientError]
+
+class S3VectorsClient(BaseClient):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors.html#S3Vectors.Client)
+    [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/)
+    """
+
+    meta: ClientMeta
+
+    @property
+    def exceptions(self) -> Exceptions:
+        """
+        S3VectorsClient exceptions.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors.html#S3Vectors.Client)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#exceptions)
+        """
+
+    def can_paginate(self, operation_name: str) -> bool:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/can_paginate.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#can_paginate)
+        """
+
+    def generate_presigned_url(
+        self,
+        ClientMethod: str,
+        Params: Mapping[str, Any] = ...,
+        ExpiresIn: int = 3600,
+        HttpMethod: str = ...,
+    ) -> str:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/generate_presigned_url.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#generate_presigned_url)
+        """
+
+    def create_index(self, **kwargs: Unpack[CreateIndexInputTypeDef]) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/create_index.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#create_index)
+        """
+
+    def create_vector_bucket(
+        self, **kwargs: Unpack[CreateVectorBucketInputTypeDef]
+    ) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/create_vector_bucket.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#create_vector_bucket)
+        """
+
+    def delete_index(self, **kwargs: Unpack[DeleteIndexInputTypeDef]) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/delete_index.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#delete_index)
+        """
+
+    def delete_vector_bucket(
+        self, **kwargs: Unpack[DeleteVectorBucketInputTypeDef]
+    ) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/delete_vector_bucket.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#delete_vector_bucket)
+        """
+
+    def delete_vector_bucket_policy(
+        self, **kwargs: Unpack[DeleteVectorBucketPolicyInputTypeDef]
+    ) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/delete_vector_bucket_policy.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#delete_vector_bucket_policy)
+        """
+
+    def delete_vectors(self, **kwargs: Unpack[DeleteVectorsInputTypeDef]) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/delete_vectors.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#delete_vectors)
+        """
+
+    def get_index(self, **kwargs: Unpack[GetIndexInputTypeDef]) -> GetIndexOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_index.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_index)
+        """
+
+    def get_vector_bucket(
+        self, **kwargs: Unpack[GetVectorBucketInputTypeDef]
+    ) -> GetVectorBucketOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_vector_bucket.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_vector_bucket)
+        """
+
+    def get_vector_bucket_policy(
+        self, **kwargs: Unpack[GetVectorBucketPolicyInputTypeDef]
+    ) -> GetVectorBucketPolicyOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_vector_bucket_policy.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_vector_bucket_policy)
+        """
+
+    def get_vectors(self, **kwargs: Unpack[GetVectorsInputTypeDef]) -> GetVectorsOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_vectors.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_vectors)
+        """
+
+    def list_indexes(self, **kwargs: Unpack[ListIndexesInputTypeDef]) -> ListIndexesOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/list_indexes.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#list_indexes)
+        """
+
+    def list_vector_buckets(
+        self, **kwargs: Unpack[ListVectorBucketsInputTypeDef]
+    ) -> ListVectorBucketsOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/list_vector_buckets.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#list_vector_buckets)
+        """
+
+    def list_vectors(self, **kwargs: Unpack[ListVectorsInputTypeDef]) -> ListVectorsOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/list_vectors.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#list_vectors)
+        """
+
+    def put_vector_bucket_policy(
+        self, **kwargs: Unpack[PutVectorBucketPolicyInputTypeDef]
+    ) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/put_vector_bucket_policy.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#put_vector_bucket_policy)
+        """
+
+    def put_vectors(self, **kwargs: Unpack[PutVectorsInputTypeDef]) -> Dict[str, Any]:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/put_vectors.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#put_vectors)
+        """
+
+    def query_vectors(
+        self, **kwargs: Unpack[QueryVectorsInputTypeDef]
+    ) -> QueryVectorsOutputTypeDef:
+        """
+        <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject
+        to change.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/query_vectors.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#query_vectors)
+        """
+
+    @overload  # type: ignore[override]
+    def get_paginator(  # type: ignore[override]
+        self, operation_name: Literal["list_indexes"]
+    ) -> ListIndexesPaginator:
+        """
+        Create a paginator for an operation.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_paginator.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_paginator)
+        """
+
+    @overload  # type: ignore[override]
+    def get_paginator(  # type: ignore[override]
+        self, operation_name: Literal["list_vector_buckets"]
+    ) -> ListVectorBucketsPaginator:
+        """
+        Create a paginator for an operation.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_paginator.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_paginator)
+        """
+
+    @overload  # type: ignore[override]
+    def get_paginator(  # type: ignore[override]
+        self, operation_name: Literal["list_vectors"]
+    ) -> ListVectorsPaginator:
+        """
+        Create a paginator for an operation.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3vectors/client/get_paginator.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3vectors/client/#get_paginator)
+        """