mypy-boto3-dynamodb 1.35.60__py3-none-any.whl → 1.35.93__py3-none-any.whl

mypy_boto3_dynamodb/service_resource.py

@@ -1,7 +1,7 @@
 """
-Type annotations for dynamodb service ServiceResource
+Type annotations for dynamodb service ServiceResource.
 
-[Open documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/)
+[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/)
 
 Usage::
 
@@ -16,18 +16,21 @@ Usage::
 
     my_table: dynamodb_resources.Table = resource.Table(...)
 ```
+
+Copyright 2025 Vlad Emelianov
 """
 
+from __future__ import annotations
+
 import sys
 from datetime import datetime
-from typing import Iterator, List, Sequence
 
 from boto3.dynamodb.table import BatchWriter
 from boto3.resources.base import ResourceMeta, ServiceResource
 from boto3.resources.collection import ResourceCollection
 
 from .client import DynamoDBClient
-from .literals import TableStatusType
+from .literals import MultiRegionConsistencyType, TableStatusType
 from .type_defs import (
     ArchivalSummaryTypeDef,
     AttributeDefinitionTypeDef,
@@ -64,6 +67,11 @@ from .type_defs import (
     UpdateTableInputTableUpdateTypeDef,
 )
 
+if sys.version_info >= (3, 9):
+    from builtins import list as List
+    from collections.abc import Iterator, Sequence
+else:
+    from typing import Iterator, List, Sequence
 if sys.version_info >= (3, 12):
     from typing import Unpack
 else:
@@ -75,67 +83,71 @@ __all__ = ("DynamoDBServiceResource", "ServiceResourceTablesCollection", "Table"
 
 class ServiceResourceTablesCollection(ResourceCollection):
     """
-    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#DynamoDB.ServiceResource.tables)
     [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
     """
 
-    def all(self) -> "ServiceResourceTablesCollection":
+    def all(self) -> ServiceResourceTablesCollection:
         """
-        Get all items from the collection, optionally with a custom page size and item count limit.
+        Get all items from the collection, optionally with a custom page size and item
+        count limit.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#DynamoDB.ServiceResource.all)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
-    def filter(  # type: ignore
+    def filter(  # type: ignore[override]
         self, *, ExclusiveStartTableName: str = ..., Limit: int = ...
-    ) -> "ServiceResourceTablesCollection":
+    ) -> ServiceResourceTablesCollection:
         """
-        Get items from the collection, passing keyword arguments along as parameters to the underlying service operation, which are typically used to filter the results.
+        Get items from the collection, passing keyword arguments along as parameters to
+        the underlying service operation, which are typically used to filter the
+        results.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#filter)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
-    def limit(self, count: int) -> "ServiceResourceTablesCollection":
+    def limit(self, count: int) -> ServiceResourceTablesCollection:
         """
         Return at most this many Tables.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#limit)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
-    def page_size(self, count: int) -> "ServiceResourceTablesCollection":
+    def page_size(self, count: int) -> ServiceResourceTablesCollection:
         """
         Fetch at most this many Tables per service request.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#page_size)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
-    def pages(self) -> Iterator[List["Table"]]:
+    def pages(self) -> Iterator[List[Table]]:
         """
         A generator which yields pages of Tables.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#pages)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
-    def __iter__(self) -> Iterator["Table"]:
+    def __iter__(self) -> Iterator[Table]:
         """
         A generator which yields Tables.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#__iter__)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
         """
 
 
 class Table(ServiceResource):
     """
-    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.Table)
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/index.html#DynamoDB.Table)
     [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#table)
     """
 
+    name: str
     attribute_definitions: List[AttributeDefinitionTypeDef]
     table_name: str
     key_schema: List[KeySchemaElementTypeDef]
@@ -161,22 +173,22 @@ class Table(ServiceResource):
     deletion_protection_enabled: bool
     on_demand_throughput: OnDemandThroughputTypeDef
     warm_throughput: TableWarmThroughputDescriptionTypeDef
-    name: str
-    meta: "DynamoDBResourceMeta"  # type: ignore
+    multi_region_consistency: MultiRegionConsistencyType
+    meta: DynamoDBResourceMeta  # type: ignore[override]
 
-    def batch_writer(self, overwrite_by_pkeys: List[str] = ...) -> BatchWriter:
+    def get_available_subresources(self) -> Sequence[str]:
         """
-        Create a batch writer object.
+        Returns a list of all the available sub-resources for this Table.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.batch_writer)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablebatch_writer-method)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/get_available_subresources.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_available_subresources-method)
         """
 
     def delete(self) -> DeleteTableOutputTypeDef:
         """
-        The `DeleteTable` operation deletes a table and all of its items.
+        The <code>DeleteTable</code> operation deletes a table and all of its items.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.delete)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/delete.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tabledelete-method)
         """
 
@@ -186,87 +198,55 @@ class Table(ServiceResource):
         """
         Deletes a single item in a table by primary key.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.delete_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/delete_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tabledelete_item-method)
         """
 
-    def get_available_subresources(self) -> Sequence[str]:
-        """
-        Returns a list of all the available sub-resources for this Resource.
-
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.get_available_subresources)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_available_subresources-method)
-        """
-
     def get_item(
         self, **kwargs: Unpack[GetItemInputTableGetItemTypeDef]
     ) -> GetItemOutputTableTypeDef:
         """
-        The `GetItem` operation returns a set of attributes for the item with the given
-        primary
-        key.
+        The <code>GetItem</code> operation returns a set of attributes for the item
+        with the given primary key.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.get_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/get_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_item-method)
         """
 
-    def load(self) -> None:
-        """
-        Calls :py:meth:`DynamoDB.Client.describe_table` to update the attributes of the
-        Table
-        resource.
-
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.load)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableload-method)
-        """
-
     def put_item(
         self, **kwargs: Unpack[PutItemInputTablePutItemTypeDef]
     ) -> PutItemOutputTableTypeDef:
         """
         Creates a new item, or replaces an old item with a new item.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.put_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/put_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableput_item-method)
         """
 
     def query(self, **kwargs: Unpack[QueryInputTableQueryTypeDef]) -> QueryOutputTableTypeDef:
         """
         You must provide the name of the partition key attribute and a single value for
-        that
-        attribute.
+        that attribute.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.query)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/query.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablequery-method)
         """
 
-    def reload(self) -> None:
-        """
-        Calls :py:meth:`DynamoDB.Client.describe_table` to update the attributes of the
-        Table
-        resource.
-
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.reload)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablereload-method)
-        """
-
     def scan(self, **kwargs: Unpack[ScanInputTableScanTypeDef]) -> ScanOutputTableTypeDef:
         """
-        The `Scan` operation returns one or more items and item attributes by accessing
-        every item in a table or a secondary
-        index.
+        The <code>Scan</code> operation returns one or more items and item attributes
+        by accessing every item in a table or a secondary index.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.scan)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/scan.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablescan-method)
         """
 
-    def update(self, **kwargs: Unpack[UpdateTableInputTableUpdateTypeDef]) -> "_Table":
+    def update(self, **kwargs: Unpack[UpdateTableInputTableUpdateTypeDef]) -> _Table:
         """
         Modifies the provisioned throughput settings, global secondary indexes, or
-        DynamoDB Streams settings for a given
-        table.
+        DynamoDB Streams settings for a given table.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.update)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableupdate-method)
         """
 
@@ -275,63 +255,81 @@ class Table(ServiceResource):
     ) -> UpdateItemOutputTableTypeDef:
         """
         Edits an existing item's attributes, or adds a new item to the table if it does
-        not already
-        exist.
+        not already exist.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.update_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableupdate_item-method)
         """
 
     def wait_until_exists(self) -> None:
         """
-        Waits until this Table is exists.
+        Waits until Table is exists.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.wait_until_exists)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_exists.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablewait_until_exists-method)
         """
 
     def wait_until_not_exists(self) -> None:
         """
-        Waits until this Table is not exists.
+        Waits until Table is not_exists.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.wait_until_not_exists)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_not_exists.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablewait_until_not_exists-method)
         """
 
+    def batch_writer(self, overwrite_by_pkeys: List[str] = ...) -> BatchWriter:
+        """
+        Create a batch writer object.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/batch_writer.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablebatch_writer-method)
+        """
+
+    def load(self) -> None:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/load.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableload-method)
+        """
+
+    def reload(self) -> None:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/reload.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablereload-method)
+        """
+
 
 _Table = Table
 
 
 class DynamoDBResourceMeta(ResourceMeta):
-    client: DynamoDBClient
+    client: DynamoDBClient  # type: ignore[override]
 
 
 class DynamoDBServiceResource(ServiceResource):
     """
-    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource)
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/index.html)
     [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/)
     """
 
-    meta: "DynamoDBResourceMeta"  # type: ignore
+    meta: DynamoDBResourceMeta  # type: ignore[override]
     tables: ServiceResourceTablesCollection
 
-    def Table(self, name: str) -> "_Table":
+    def get_available_subresources(self) -> Sequence[str]:
         """
-        Creates a Table resource.
+        Returns a list of all the available sub-resources for this resource.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.Table)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcetable-method)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/get_available_subresources.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourceget_available_subresources-method)
         """
 
     def batch_get_item(
         self, **kwargs: Unpack[BatchGetItemInputServiceResourceBatchGetItemTypeDef]
     ) -> BatchGetItemOutputServiceResourceTypeDef:
         """
-        The `BatchGetItem` operation returns the attributes of one or more items from
-        one or more
-        tables.
+        The <code>BatchGetItem</code> operation returns the attributes of one or more
+        items from one or more tables.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.batch_get_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_get_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_get_item-method)
         """
 
@@ -339,27 +337,27 @@ class DynamoDBServiceResource(ServiceResource):
         self, **kwargs: Unpack[BatchWriteItemInputServiceResourceBatchWriteItemTypeDef]
     ) -> BatchWriteItemOutputServiceResourceTypeDef:
         """
-        The `BatchWriteItem` operation puts or deletes multiple items in one or more
-        tables.
+        The <code>BatchWriteItem</code> operation puts or deletes multiple items in one
+        or more tables.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.batch_write_item)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_write_item.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_write_item-method)
         """
 
     def create_table(
         self, **kwargs: Unpack[CreateTableInputServiceResourceCreateTableTypeDef]
-    ) -> "_Table":
+    ) -> _Table:
         """
-        The `CreateTable` operation adds a new table to your account.
+        The <code>CreateTable</code> operation adds a new table to your account.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.create_table)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/create_table.html)
         [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcecreate_table-method)
         """
 
-    def get_available_subresources(self) -> Sequence[str]:
+    def Table(self, name: str) -> _Table:
         """
-        Returns a list of all the available sub-resources for this Resource.
+        Creates a Table resource.
 
-        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.get_available_subresources)
-        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourceget_available_subresources-method)
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/Table.html)
+        [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcetable-method)
         """