types-boto3 1.35.71__py3-none-any.whl

types-boto3/__init__.pyi

@@ -0,0 +1,60 @@
+"""
+Type annotations for boto3 module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any
+
+from boto3 import session as session
+from boto3.session import Session as Session
+from botocore.config import Config
+from botocore.session import Session as BotocoreSession
+
+__author__: str
+__version__: str
+
+DEFAULT_SESSION: Session | None
+
+def setup_default_session(
+    *,
+    aws_access_key_id: str | None = ...,
+    aws_secret_access_key: str | None = ...,
+    aws_session_token: str | None = ...,
+    region_name: str | None = ...,
+    botocore_session: BotocoreSession | None = ...,
+    profile_name: str | None = ...,
+) -> None: ...
+def set_stream_logger(
+    name: str = ..., level: int = ..., format_string: str | None = ...
+) -> None: ...
+def _get_default_session() -> Session: ...
+
+class NullHandler(logging.Handler):
+    def emit(self, record: Any) -> Any: ...
+
+def client(
+    service_name: str,
+    region_name: str | None = ...,
+    api_version: str | None = ...,
+    use_ssl: bool | None = ...,
+    verify: bool | str | None = ...,
+    endpoint_url: str | None = ...,
+    aws_access_key_id: str | None = ...,
+    aws_secret_access_key: str | None = ...,
+    aws_session_token: str | None = ...,
+    config: Config | None = ...,
+) -> Any: ...
+def resource(
+    service_name: str,
+    region_name: str | None = ...,
+    api_version: str | None = ...,
+    use_ssl: bool | None = ...,
+    verify: bool | str | None = ...,
+    endpoint_url: str | None = ...,
+    aws_access_key_id: str | None = ...,
+    aws_secret_access_key: str | None = ...,
+    aws_session_token: str | None = ...,
+    config: Config | None = ...,
+) -> Any: ...

types-boto3/compat.pyi

@@ -0,0 +1,13 @@
+"""
+Type annotations for boto3.compat module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import os
+
+SOCKET_ERROR: type[ConnectionError]
+
+def filter_python_deprecation_warnings() -> None: ...
+
+rename_file = os.rename

types-boto3/crt.pyi

@@ -0,0 +1,28 @@
+"""
+Type annotations for boto3.crt module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import threading
+from typing import Any
+
+from botocore.client import BaseClient
+from s3transfer.crt import BotocoreCRTRequestSerializer, CRTTransferManager
+
+CRT_S3_CLIENT: CRTS3Client | None = ...
+BOTOCORE_CRT_SERIALIZER: BotocoreCRTRequestSerializer | None = ...
+
+CLIENT_CREATION_LOCK: threading.Lock = ...
+PROCESS_LOCK_NAME: str = ...
+
+def get_crt_s3_client(client: BaseClient, config: Any) -> CRTS3Client: ...
+
+class CRTS3Client:
+    def __init__(
+        self, crt_client: Any, process_lock: Any, region: str, cred_provider: Any
+    ) -> None: ...
+
+def is_crt_compatible_request(client: BaseClient, crt_s3_client: CRTS3Client) -> bool: ...
+def compare_identity(boto3_creds: Any, crt_s3_creds: Any) -> bool: ...
+def create_crt_transfer_manager(client: BaseClient, config: Any) -> CRTTransferManager | None: ...

types-boto3/docs/__init__.pyi

@@ -0,0 +1,9 @@
+"""
+Type annotations for boto3.docs module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.session import Session
+
+def generate_docs(root_dir: str, session: Session) -> None: ...

types-boto3/docs/action.pyi

@@ -0,0 +1,37 @@
+"""
+Type annotations for boto3.docs.action module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Action
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+PUT_DATA_WARNING_MESSAGE: str
+WARNING_MESSAGES: dict[str, dict[str, str]]
+IGNORE_PARAMS: dict[str, dict[str, list[str]]]
+
+class ActionDocumenter(NestedDocumenter):
+    def document_actions(self, section: DocumentStructure) -> None: ...
+
+def document_action(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    action_model: Action,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...
+def document_load_reload_action(
+    section: DocumentStructure,
+    action_name: str,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    load_model: Action,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

types-boto3/docs/attr.pyi

@@ -0,0 +1,33 @@
+"""
+Type annotations for boto3.docs.attr module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Identifier
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.params import ResponseParamsDocumenter
+from botocore.hooks import BaseEventHooks
+from botocore.model import Shape
+
+class ResourceShapeDocumenter(ResponseParamsDocumenter):
+    EVENT_NAME: str
+
+def document_attribute(
+    section: DocumentStructure,
+    service_name: str,
+    resource_name: str,
+    attr_name: str,
+    event_emitter: BaseEventHooks,
+    attr_model: Shape,
+    include_signature: bool = True,
+) -> None: ...
+def document_identifier(
+    section: DocumentStructure,
+    resource_name: str,
+    identifier_model: Identifier,
+    include_signature: bool = ...,
+) -> None: ...
+def document_reference(
+    section: DocumentStructure, reference_model: Shape, include_signature: bool = ...
+) -> None: ...

types-boto3/docs/base.pyi

@@ -0,0 +1,19 @@
+"""
+Type annotations for boto3.docs.base module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+class BaseDocumenter:
+    member_map: dict[str, Any]
+    represents_service_resource: Any
+    def __init__(self, resource: Any) -> None: ...
+    @property
+    def class_name(self) -> str: ...
+
+class NestedDocumenter(BaseDocumenter):
+    def __init__(self, resource: Any, root_docs_path: str) -> None: ...
+    @property
+    def class_name(self) -> str: ...

types-boto3/docs/client.pyi

@@ -0,0 +1,9 @@
+"""
+Type annotations for boto3.docs.client module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.client import ClientDocumenter
+
+class Boto3ClientDocumenter(ClientDocumenter): ...

types-boto3/docs/collection.pyi

@@ -0,0 +1,37 @@
+"""
+Type annotations for boto3.docs.collection module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Action, Collection
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+class CollectionDocumenter(NestedDocumenter):
+    def document_collections(self, section: DocumentStructure) -> None: ...
+
+def document_collection_object(
+    section: DocumentStructure, collection_model: Collection, include_signature: bool = ...
+) -> None: ...
+def document_batch_action(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    batch_action_model: Action,
+    service_model: ServiceModel,
+    collection_model: Collection,
+    include_signature: bool = ...,
+) -> None: ...
+def document_collection_method(
+    section: DocumentStructure,
+    resource_name: str,
+    action_name: str,
+    event_emitter: BaseEventHooks,
+    collection_model: Collection,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

types-boto3/docs/docstring.pyi

@@ -0,0 +1,18 @@
+"""
+Type annotations for boto3.docs.docstring module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.docstring import LazyLoadedDocstring
+
+class ActionDocstring(LazyLoadedDocstring): ...
+class LoadReloadDocstring(LazyLoadedDocstring): ...
+class SubResourceDocstring(LazyLoadedDocstring): ...
+class AttributeDocstring(LazyLoadedDocstring): ...
+class IdentifierDocstring(LazyLoadedDocstring): ...
+class ReferenceDocstring(LazyLoadedDocstring): ...
+class CollectionDocstring(LazyLoadedDocstring): ...
+class CollectionMethodDocstring(LazyLoadedDocstring): ...
+class BatchActionDocstring(LazyLoadedDocstring): ...
+class ResourceWaiterDocstring(LazyLoadedDocstring): ...

types-boto3/docs/method.pyi

@@ -0,0 +1,27 @@
+"""
+Type annotations for boto3.docs.method module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from boto3.resources.model import Action
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+
+def document_model_driven_resource_method(
+    section: DocumentStructure,
+    method_name: str,
+    operation_model: Any,
+    event_emitter: BaseEventHooks,
+    method_description: str | None = ...,
+    example_prefix: str | None = ...,
+    include_input: Any | None = ...,
+    include_output: Any | None = ...,
+    exclude_input: Any | None = ...,
+    exclude_output: Any | None = ...,
+    document_output: bool = ...,
+    resource_action_model: Action | None = ...,
+    include_signature: bool = ...,
+) -> None: ...

types-boto3/docs/resource.pyi

@@ -0,0 +1,20 @@
+"""
+Type annotations for boto3.docs.resource module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.session import Session
+
+from .base import BaseDocumenter
+
+class ResourceDocumenter(BaseDocumenter):
+    def __init__(self, resource: Any, botocore_session: Session, root_docs_path: str) -> None: ...
+    def document_resource(self, section: DocumentStructure) -> None: ...
+
+class ServiceResourceDocumenter(ResourceDocumenter):
+    @property
+    def class_name(self) -> str: ...

types-boto3/docs/service.pyi

@@ -0,0 +1,17 @@
+"""
+Type annotations for boto3.docs.service module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter
+from botocore.session import Session
+
+class ServiceDocumenter(BaseServiceDocumenter):
+    EXAMPLE_PATH: str
+    sections: list[str]
+    def __init__(self, service_name: str, session: Session, root_docs_path: str) -> None: ...
+    def document_service(self) -> bytes: ...
+    def client_api(self, section: DocumentStructure) -> None: ...
+    def resource_section(self, section: DocumentStructure) -> None: ...

types-boto3/docs/subresource.pyi

@@ -0,0 +1,22 @@
+"""
+Type annotations for boto3.docs.subresource module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import ResourceModel
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+class SubResourceDocumenter(NestedDocumenter):
+    def document_sub_resources(self, section: DocumentStructure) -> None: ...
+
+def document_sub_resource(
+    section: DocumentStructure,
+    resource_name: str,
+    sub_resource_model: ResourceModel,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

types-boto3/docs/utils.pyi

@@ -0,0 +1,30 @@
+"""
+Type annotations for boto3.docs.utils module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Iterable, Mapping
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+
+def get_resource_ignore_params(params: Mapping[str, Any]) -> list[str]: ...
+def is_resource_action(action_handle: Any) -> bool: ...
+def get_resource_public_actions(resource_class: Any) -> list[Any]: ...
+def get_identifier_values_for_example(identifier_names: Iterable[str]) -> str: ...
+def get_identifier_args_for_signature(identifier_names: Iterable[str]) -> str: ...
+def get_identifier_description(resource_name: str, identifier_name: str) -> str: ...
+def add_resource_type_overview(
+    section: DocumentStructure,
+    resource_type: str,
+    description: str,
+    intro_link: str | None = ...,
+) -> None: ...
+
+class DocumentModifiedShape:
+    def __init__(
+        self, shape_name: str, new_type: str, new_description: str, new_example_value: str
+    ) -> None: ...
+    def replace_documentation_for_matching_shape(
+        self, event_name: str, section: DocumentStructure, **kwargs: Any
+    ) -> None: ...

types-boto3/docs/waiter.pyi

@@ -0,0 +1,33 @@
+"""
+Type annotations for boto3.docs.waiter module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+from botocore.waiter import WaiterModel
+
+from .base import NestedDocumenter
+
+class WaiterResourceDocumenter(NestedDocumenter):
+    def __init__(
+        self,
+        resource: Any,
+        service_waiter_model: WaiterModel,
+        root_docs_path: str,
+    ) -> None: ...
+    def document_resource_waiters(self, section: DocumentStructure) -> None: ...
+
+def document_resource_waiter(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    service_model: ServiceModel,
+    resource_waiter_model: Any,
+    service_waiter_model: WaiterModel,
+    include_signature: bool = ...,
+) -> None: ...

types-boto3/dynamodb/conditions.pyi

@@ -0,0 +1,136 @@
+"""
+Type annotations for boto3.dynamodb.conditions module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Literal, NamedTuple, Pattern, TypedDict
+
+ATTR_NAME_REGEX: Pattern[str]
+
+class _ConditionBaseExpressionType(TypedDict):
+    format: str
+    operator: str
+    values: list[Any]
+
+class ConditionBase:
+    expression_format: str
+    expression_operator: str
+    has_grouped_values: bool
+    def __init__(self, *values: Any) -> None: ...
+    def __and__(self, other: ConditionBase) -> And: ...
+    def __or__(self, other: ConditionBase) -> Or: ...
+    def __invert__(self) -> Not: ...
+    def get_expression(self) -> _ConditionBaseExpressionType: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+
+class AttributeBase:
+    def __init__(self, name: str) -> None:
+        self.name: str = ...
+
+    def __and__(self, value: Any) -> Any: ...
+    def __or__(self, value: Any) -> Any: ...
+    def __invert__(self) -> Any: ...
+    def eq(self, value: Any) -> Equals: ...
+    def lt(self, value: Any) -> LessThan: ...
+    def lte(self, value: Any) -> LessThanEquals: ...
+    def gt(self, value: Any) -> GreaterThan: ...
+    def gte(self, value: Any) -> GreaterThanEquals: ...
+    def begins_with(self, value: Any) -> BeginsWith: ...
+    def between(self, low_value: Any, high_value: Any) -> Between: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+
+class ConditionAttributeBase(ConditionBase, AttributeBase):
+    def __init__(self, *values: Any) -> None: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+
+class ComparisonCondition(ConditionBase):
+    expression_format: Literal["{0} {operator} {1}"]  # type: ignore [override]
+
+class Equals(ComparisonCondition):
+    expression_operator: Literal["="]  # type: ignore [override]
+
+class NotEquals(ComparisonCondition):
+    expression_operator: Literal["<>"]  # type: ignore [override]
+
+class LessThan(ComparisonCondition):
+    expression_operator: Literal["<"]  # type: ignore [override]
+
+class LessThanEquals(ComparisonCondition):
+    expression_operator: Literal["<="]  # type: ignore [override]
+
+class GreaterThan(ComparisonCondition):
+    expression_operator: Literal[">"]  # type: ignore [override]
+
+class GreaterThanEquals(ComparisonCondition):
+    expression_operator: Literal[">="]  # type: ignore [override]
+
+class In(ComparisonCondition):
+    expression_operator: Literal["IN"]  # type: ignore [override]
+    has_grouped_values: bool
+
+class Between(ConditionBase):
+    expression_operator: Literal["BETWEEN"]  # type: ignore [override]
+    expression_format: Literal["{0} {operator} {1} AND {2}"]  # type: ignore [override]
+
+class BeginsWith(ConditionBase):
+    expression_operator: Literal["begins_with"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0}, {1})"]  # type: ignore [override]
+
+class Contains(ConditionBase):
+    expression_operator: Literal["contains"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0}, {1})"]  # type: ignore [override]
+
+class Size(ConditionAttributeBase):
+    expression_operator: Literal["size"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0})"]  # type: ignore [override]
+
+class AttributeType(ConditionBase):
+    expression_operator: Literal["attribute_type"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0}, {1})"]  # type: ignore [override]
+
+class AttributeExists(ConditionBase):
+    expression_operator: Literal["attribute_exists"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0})"]  # type: ignore [override]
+
+class AttributeNotExists(ConditionBase):
+    expression_operator: Literal["attribute_not_exists"]  # type: ignore [override]
+    expression_format: Literal["{operator}({0})"]  # type: ignore [override]
+
+class And(ConditionBase):
+    expression_operator: Literal["AND"]  # type: ignore [override]
+    expression_format: Literal["({0} {operator} {1})"]  # type: ignore [override]
+
+class Or(ConditionBase):
+    expression_operator: Literal["OR"]  # type: ignore [override]
+    expression_format: Literal["({0} {operator} {1})"]  # type: ignore [override]
+
+class Not(ConditionBase):
+    expression_operator: Literal["NOT"]  # type: ignore [override]
+    expression_format: Literal["({operator} {0})"]  # type: ignore [override]
+
+class Key(AttributeBase): ...
+
+class Attr(AttributeBase):
+    def ne(self, value: Any) -> NotEquals: ...
+    def is_in(self, value: Any) -> In: ...
+    def exists(self) -> AttributeExists: ...
+    def not_exists(self) -> AttributeNotExists: ...
+    def contains(self, value: Any) -> Contains: ...
+    def size(self) -> Size: ...
+    def attribute_type(self, value: Any) -> AttributeType: ...
+
+class BuiltConditionExpression(NamedTuple):
+    condition_expression: str
+    attribute_name_placeholders: dict[str, str]
+    attribute_value_placeholders: dict[str, Any]
+
+class ConditionExpressionBuilder:
+    def __init__(self) -> None: ...
+    def reset(self) -> None: ...
+    def build_expression(
+        self, condition: ConditionBase, is_key_condition: bool = ...
+    ) -> BuiltConditionExpression: ...

types-boto3/dynamodb/table.pyi

@@ -0,0 +1,39 @@
+"""
+Type annotations for boto3.dynamodb.table module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from types import TracebackType
+from typing import Any, TypeVar
+
+from botocore.client import BaseClient
+
+logger: logging.Logger
+
+def register_table_methods(base_classes: list[Any], **kwargs: Any) -> None: ...
+
+class TableResource:
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+    def batch_writer(self, overwrite_by_pkeys: list[str] | None = ...) -> BatchWriter: ...
+
+_R = TypeVar("_R")
+
+class BatchWriter:
+    def __init__(
+        self,
+        table_name: str,
+        client: BaseClient,
+        flush_amount: int = ...,
+        overwrite_by_pkeys: list[str] | None = ...,
+    ) -> None: ...
+    def put_item(self, Item: dict[str, Any]) -> None: ...
+    def delete_item(self, Key: dict[str, Any]) -> None: ...
+    def __enter__(self: _R) -> _R: ...
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        tb: TracebackType | None,
+    ) -> None: ...

types-boto3/dynamodb/transform.pyi

@@ -0,0 +1,55 @@
+"""
+Type annotations for boto3.dynamodb.transform module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Callable
+
+from boto3.dynamodb.conditions import ConditionExpressionBuilder
+from boto3.dynamodb.types import TypeDeserializer, TypeSerializer
+from boto3.resources.model import ResourceModel
+from botocore.model import Shape
+
+def register_high_level_interface(base_classes: list[Any], **kwargs: Any) -> None: ...
+def copy_dynamodb_params(params: Any, **kwargs: Any) -> Any: ...
+
+class DynamoDBHighLevelResource:
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+
+class TransformationInjector:
+    def __init__(
+        self,
+        transformer: ParameterTransformer | None = ...,
+        condition_builder: ConditionExpressionBuilder | None = ...,
+        serializer: TypeSerializer | None = ...,
+        deserializer: TypeDeserializer | None = ...,
+    ) -> None: ...
+    def inject_condition_expressions(
+        self, params: dict[str, Any], model: ResourceModel
+    ) -> None: ...
+    def inject_attribute_value_input(
+        self, params: dict[str, Any], model: ResourceModel
+    ) -> None: ...
+    def inject_attribute_value_output(
+        self, parsed: dict[str, Any], model: ResourceModel
+    ) -> None: ...
+
+class ConditionExpressionTransformation:
+    def __init__(
+        self,
+        condition_builder: ConditionExpressionBuilder,
+        placeholder_names: list[str],
+        placeholder_values: list[str],
+        is_key_condition: bool = ...,
+    ) -> None: ...
+    def __call__(self, value: Any) -> Any: ...
+
+class ParameterTransformer:
+    def transform(
+        self,
+        params: dict[str, Any],
+        model: Shape,
+        transformation: Callable[[Any], Any],
+        target_shape: str,
+    ) -> None: ...