types-boto3-dynamodb 1.36.0__py3-none-any.whl

types_boto3_dynamodb/service_resource.py

@@ -0,0 +1,363 @@
+"""
+Type annotations for dynamodb service ServiceResource.
+
+[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/)
+
+Usage::
+
+    ```python
+    from boto3.session import Session
+
+    from types_boto3_dynamodb.service_resource import DynamoDBServiceResource
+    import types_boto3_dynamodb.service_resource as dynamodb_resources
+
+    session = Session()
+    resource: DynamoDBServiceResource = session.resource("dynamodb")
+
+    my_table: dynamodb_resources.Table = resource.Table(...)
+```
+
+Copyright 2025 Vlad Emelianov
+"""
+
+from __future__ import annotations
+
+import sys
+from datetime import datetime
+
+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 MultiRegionConsistencyType, TableStatusType
+from .type_defs import (
+    ArchivalSummaryTypeDef,
+    AttributeDefinitionTypeDef,
+    BatchGetItemInputServiceResourceBatchGetItemTypeDef,
+    BatchGetItemOutputServiceResourceTypeDef,
+    BatchWriteItemInputServiceResourceBatchWriteItemTypeDef,
+    BatchWriteItemOutputServiceResourceTypeDef,
+    BillingModeSummaryTypeDef,
+    CreateTableInputServiceResourceCreateTableTypeDef,
+    DeleteItemInputTableDeleteItemTypeDef,
+    DeleteItemOutputTableTypeDef,
+    DeleteTableOutputTypeDef,
+    GetItemInputTableGetItemTypeDef,
+    GetItemOutputTableTypeDef,
+    GlobalSecondaryIndexDescriptionTypeDef,
+    KeySchemaElementTypeDef,
+    LocalSecondaryIndexDescriptionTypeDef,
+    OnDemandThroughputTypeDef,
+    ProvisionedThroughputDescriptionTypeDef,
+    PutItemInputTablePutItemTypeDef,
+    PutItemOutputTableTypeDef,
+    QueryInputTableQueryTypeDef,
+    QueryOutputTableTypeDef,
+    ReplicaDescriptionTypeDef,
+    RestoreSummaryTypeDef,
+    ScanInputTableScanTypeDef,
+    ScanOutputTableTypeDef,
+    SSEDescriptionTypeDef,
+    StreamSpecificationTypeDef,
+    TableClassSummaryTypeDef,
+    TableWarmThroughputDescriptionTypeDef,
+    UpdateItemInputTableUpdateItemTypeDef,
+    UpdateItemOutputTableTypeDef,
+    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:
+    from typing_extensions import Unpack
+
+
+__all__ = ("DynamoDBServiceResource", "ServiceResourceTablesCollection", "Table")
+
+
+class ServiceResourceTablesCollection(ResourceCollection):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#DynamoDB.ServiceResource.tables)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
+    """
+
+    def all(self) -> ServiceResourceTablesCollection:
+        """
+        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/service-resource/tables.html#DynamoDB.ServiceResource.all)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
+        """
+
+    def filter(  # type: ignore[override]
+        self, *, ExclusiveStartTableName: str = ..., Limit: int = ...
+    ) -> 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.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#filter)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#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/service-resource/tables.html#limit)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#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/service-resource/tables.html#page_size)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
+        """
+
+    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/service-resource/tables.html#pages)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
+        """
+
+    def __iter__(self) -> Iterator[Table]:
+        """
+        A generator which yields Tables.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#__iter__)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
+        """
+
+
+class Table(ServiceResource):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/index.html#DynamoDB.Table)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#table)
+    """
+
+    name: str
+    attribute_definitions: List[AttributeDefinitionTypeDef]
+    table_name: str
+    key_schema: List[KeySchemaElementTypeDef]
+    table_status: TableStatusType
+    creation_date_time: datetime
+    provisioned_throughput: ProvisionedThroughputDescriptionTypeDef
+    table_size_bytes: int
+    item_count: int
+    table_arn: str
+    table_id: str
+    billing_mode_summary: BillingModeSummaryTypeDef
+    local_secondary_indexes: List[LocalSecondaryIndexDescriptionTypeDef]
+    global_secondary_indexes: List[GlobalSecondaryIndexDescriptionTypeDef]
+    stream_specification: StreamSpecificationTypeDef
+    latest_stream_label: str
+    latest_stream_arn: str
+    global_table_version: str
+    replicas: List[ReplicaDescriptionTypeDef]
+    restore_summary: RestoreSummaryTypeDef
+    sse_description: SSEDescriptionTypeDef
+    archival_summary: ArchivalSummaryTypeDef
+    table_class_summary: TableClassSummaryTypeDef
+    deletion_protection_enabled: bool
+    on_demand_throughput: OnDemandThroughputTypeDef
+    warm_throughput: TableWarmThroughputDescriptionTypeDef
+    multi_region_consistency: MultiRegionConsistencyType
+    meta: DynamoDBResourceMeta  # type: ignore[override]
+
+    def get_available_subresources(self) -> Sequence[str]:
+        """
+        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/table/get_available_subresources.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tableget_available_subresources-method)
+        """
+
+    def delete(self) -> DeleteTableOutputTypeDef:
+        """
+        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/table/delete.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tabledelete-method)
+        """
+
+    def delete_item(
+        self, **kwargs: Unpack[DeleteItemInputTableDeleteItemTypeDef]
+    ) -> DeleteItemOutputTableTypeDef:
+        """
+        Deletes a single item in a table by primary key.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/delete_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tabledelete_item-method)
+        """
+
+    def get_item(
+        self, **kwargs: Unpack[GetItemInputTableGetItemTypeDef]
+    ) -> GetItemOutputTableTypeDef:
+        """
+        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/table/get_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tableget_item-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/table/put_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_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.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/query.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tablequery-method)
+        """
+
+    def scan(self, **kwargs: Unpack[ScanInputTableScanTypeDef]) -> ScanOutputTableTypeDef:
+        """
+        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/table/scan.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tablescan-method)
+        """
+
+    def update(self, **kwargs: Unpack[UpdateTableInputTableUpdateTypeDef]) -> _Table:
+        """
+        Modifies the provisioned throughput settings, global secondary indexes, or
+        DynamoDB Streams settings for a given table.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tableupdate-method)
+        """
+
+    def update_item(
+        self, **kwargs: Unpack[UpdateItemInputTableUpdateItemTypeDef]
+    ) -> UpdateItemOutputTableTypeDef:
+        """
+        Edits an existing item's attributes, or adds a new item to the table if it does
+        not already exist.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tableupdate_item-method)
+        """
+
+    def wait_until_exists(self) -> None:
+        """
+        Waits until Table is exists.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_exists.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tablewait_until_exists-method)
+        """
+
+    def wait_until_not_exists(self) -> None:
+        """
+        Waits until Table is not_exists.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_not_exists.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_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 types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_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 types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_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 types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#tablereload-method)
+        """
+
+
+_Table = Table
+
+
+class DynamoDBResourceMeta(ResourceMeta):
+    client: DynamoDBClient  # type: ignore[override]
+
+
+class DynamoDBServiceResource(ServiceResource):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/index.html)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/)
+    """
+
+    meta: DynamoDBResourceMeta  # type: ignore[override]
+    tables: ServiceResourceTablesCollection
+
+    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/service-resource/get_available_subresources.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#dynamodbserviceresourceget_available_subresources-method)
+        """
+
+    def batch_get_item(
+        self, **kwargs: Unpack[BatchGetItemInputServiceResourceBatchGetItemTypeDef]
+    ) -> BatchGetItemOutputServiceResourceTypeDef:
+        """
+        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/service-resource/batch_get_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_get_item-method)
+        """
+
+    def batch_write_item(
+        self, **kwargs: Unpack[BatchWriteItemInputServiceResourceBatchWriteItemTypeDef]
+    ) -> BatchWriteItemOutputServiceResourceTypeDef:
+        """
+        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/service-resource/batch_write_item.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_write_item-method)
+        """
+
+    def create_table(
+        self, **kwargs: Unpack[CreateTableInputServiceResourceCreateTableTypeDef]
+    ) -> _Table:
+        """
+        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/service-resource/create_table.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#dynamodbserviceresourcecreate_table-method)
+        """
+
+    def Table(self, name: str) -> _Table:
+        """
+        Creates a Table resource.
+
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/Table.html)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_dynamodb/service_resource/#dynamodbserviceresourcetable-method)
+        """