Metadata-Version: 2.1
Name: mypy-boto3-dynamodb
Version: 1.17.80
Summary: Type annotations for boto3.DynamoDB 1.17.80 service, generated by mypy-boto3-buider 4.14.0
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Description: # mypy-boto3-dynamodb<a id="mypy-boto3-dynamodb"></a>
        
        [![PyPI - mypy-boto3-dynamodb](https://img.shields.io/pypi/v/mypy-boto3-dynamodb.svg?color=blue)](https://pypi.org/project/mypy-boto3-dynamodb)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-dynamodb.svg?color=blue)](https://pypi.org/project/mypy-boto3-dynamodb)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-dynamodb?color=blue)](https://pypistats.org/packages/mypy-boto3-dynamodb)
        
        ![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
        
        Type annotations for
        [boto3.DynamoDB 1.17.80](https://boto3.amazonaws.com/v1/documentation/api/1.17.80/reference/services/dynamodb.html#DynamoDB)
        service compatible with [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/),
        [Emacs](https://www.gnu.org/software/emacs/),
        [Sublime Text](https://www.sublimetext.com/),
        [mypy](https://github.com/python/mypy),
        [pyright](https://github.com/microsoft/pyright) and other tools.
        
        Generated by
        [mypy-boto3-buider 4.14.0](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on
        [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
        [mypy-boto3-dynamodb docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/)
        
        See how it helps to find and fix potential bugs:
        
        ![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
        
        - [mypy-boto3-dynamodb](#mypy-boto3-dynamodb)
          - [How to install](#how-to-install)
          - [Usage](#usage)
            - [VSCode](#vscode)
            - [PyCharm](#pycharm)
            - [Other IDEs](#other-ides)
            - [mypy](#mypy)
            - [pyright](#pyright)
          - [Explicit type annotations](#explicit-type-annotations)
            - [Client annotations](#client-annotations)
            - [Paginators annotations](#paginators-annotations)
            - [Waiters annotations](#waiters-annotations)
            - [Service Resource annotations](#service-resource-annotations)
            - [Other resources annotations](#other-resources-annotations)
            - [Collections annotations](#collections-annotations)
            - [Literals](#literals)
            - [Typed dictionaries](#typed-dictionaries)
          - [Versioning](#versioning)
          - [Documentation](#documentation)
          - [Support and contributing](#support-and-contributing)
        
        ## How to install<a id="how-to-install"></a>
        
        Install `boto3-stubs` for `DynamoDB` service.
        
        ```bash
        python -m pip install boto3-stubs[dynamodb]
        ```
        
        ## Usage<a id="usage"></a>
        
        ### VSCode<a id="vscode"></a>
        
        - Install
          [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
        - Install
          [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
        - Set `Pylance` as your Python Language Server
        - Install `boto-stubs[dynamodb]` in your environment:
          `python -m pip install 'boto3-stubs[dynamodb]'`
        
        Both type checking and auto-complete should work for `DynamoDB` service. No
        explicit type annotations required, write your `boto3` code as usual.
        
        ### PyCharm<a id="pycharm"></a>
        
        - Install `boto-stubs[dynamodb]` in your environment:
          `python -m pip install 'boto3-stubs[dynamodb]'`
        
        Both type checking and auto-complete should work for `DynamoDB` service. No
        explicit type annotations required, write your `boto3` code as usual.
        Auto-complete can be slow on big projects or if you have a lot of installed
        `boto3-stubs` submodules.
        
        ### Other IDEs<a id="other-ides"></a>
        
        Not tested, but as long as your IDE support `mypy` or `pyright`, everything
        should work.
        
        ### mypy<a id="mypy"></a>
        
        - Install `mypy`: `python -m pip install mypy`
        - Install `boto-stubs[dynamodb]` in your environment:
          `python -m pip install 'boto3-stubs[dynamodb]'`
        - Run `mypy` as usual
        
        Type checking should work for `DynamoDB` service. No explicit type annotations
        required, write your `boto3` code as usual.
        
        ### pyright<a id="pyright"></a>
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[dynamodb]` in your environment:
          `python -m pip install 'boto3-stubs[dynamodb]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `DynamoDB` service. No explicit type annotations
        required, write your `boto3` code as usual.
        
        ## Explicit type annotations<a id="explicit-type-annotations"></a>
        
        ### Client annotations<a id="client-annotations"></a>
        
        `DynamoDBClient` provides annotations for `boto3.client("dynamodb")`.
        
        ```python
        import boto3
        
        from mypy_boto3_dynamodb import DynamoDBClient
        
        client: DynamoDBClient = boto3.client("dynamodb")
        
        # now client usage is checked by mypy and IDE should provide code auto-complete
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_client: DynamoDBClient = session.client("dynamodb")
        ```
        
        ### Paginators annotations<a id="paginators-annotations"></a>
        
        `mypy_boto3_dynamodb.paginator` module contains type annotations for all
        paginators.
        
        ```python
        from mypy_boto3_dynamodb import DynamoDBClient
        from mypy_boto3_dynamodb.paginator import (
            ListBackupsPaginator,
            ListTablesPaginator,
            ListTagsOfResourcePaginator,
            QueryPaginator,
            ScanPaginator,
        )
        
        client: DynamoDBClient = boto3.client("dynamodb")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        list_backups_paginator: ListBackupsPaginator = client.get_paginator("list_backups")
        list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")
        list_tags_of_resource_paginator: ListTagsOfResourcePaginator = client.get_paginator("list_tags_of_resource")
        query_paginator: QueryPaginator = client.get_paginator("query")
        scan_paginator: ScanPaginator = client.get_paginator("scan")
        ```
        
        ### Waiters annotations<a id="waiters-annotations"></a>
        
        `mypy_boto3_dynamodb.waiter` module contains type annotations for all waiters.
        
        ```python
        from mypy_boto3_dynamodb import DynamoDBClient
        from mypy_boto3_dynamodb.waiter import (
            TableExistsWaiter,
            TableNotExistsWaiter,
        )
        
        client: DynamoDBClient = boto3.client("dynamodb")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        table_exists_waiter: TableExistsWaiter = client.get_waiter("table_exists")
        table_not_exists_waiter: TableNotExistsWaiter = client.get_waiter("table_not_exists")
        ```
        
        ### Service Resource annotations<a id="service-resource-annotations"></a>
        
        `DynamoDBServiceResource` provides annotations for
        `boto3.resource("dynamodb")`.
        
        ```python
        from mypy_boto3_dynamodb import DynamoDBServiceResource
        
        resource: DynamoDBServiceResource = boto3.resource("dynamodb")
        
        # now resource usage is checked by mypy and IDE should provide code auto-complete
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_resource: DynamoDBServiceResource = session.resource("dynamodb")
        ```
        
        ### Other resources annotations<a id="other-resources-annotations"></a>
        
        `mypy_boto3_dynamodb.service_resource` module contains type annotations for all
        resources.
        
        ```python
        from mypy_boto3_dynamodb import DynamoDBServiceResource
        from mypy_boto3_dynamodb.service_resource import (
            Table,
        )
        
        resource: DynamoDBServiceResource = boto3.resource("dynamodb")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        my_table: Table = resource.Table(...)
        ```
        
        ### Collections annotations<a id="collections-annotations"></a>
        
        `mypy_boto3_dynamodb.service_resource` module contains type annotations for all
        `DynamoDBServiceResource` collections.
        
        ```python
        from mypy_boto3_dynamodb import DynamoDBServiceResource
        from mypy_boto3_dynamodb.service_resource import (
            ServiceResourceTablesCollection,
        )
        
        resource: DynamoDBServiceResource = boto3.resource("dynamodb")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        tables: dynamodb_resources.ServiceResourceTablesCollection = resource.tables
        ```
        
        ### Literals<a id="literals"></a>
        
        `mypy_boto3_dynamodb.literals` module contains literals extracted from shapes
        that can be used in user code for type checking.
        
        ```python
        from mypy_boto3_dynamodb.literals import (
            AttributeActionType,
            BackupStatusType,
            BackupTypeFilterType,
            BackupTypeType,
            BatchStatementErrorCodeEnumType,
            BillingModeType,
            ComparisonOperatorType,
            ConditionalOperatorType,
            ContinuousBackupsStatusType,
            ContributorInsightsActionType,
            ContributorInsightsStatusType,
            DestinationStatusType,
            ExportFormatType,
            ExportStatusType,
            GlobalTableStatusType,
            IndexStatusType,
            KeyTypeType,
            ListBackupsPaginatorName,
            ListTablesPaginatorName,
            ListTagsOfResourcePaginatorName,
            PointInTimeRecoveryStatusType,
            ProjectionTypeType,
            QueryPaginatorName,
            ReplicaStatusType,
            ReturnConsumedCapacityType,
            ReturnItemCollectionMetricsType,
            ReturnValueType,
            ReturnValuesOnConditionCheckFailureType,
            S3SseAlgorithmType,
            SSEStatusType,
            SSETypeType,
            ScalarAttributeTypeType,
            ScanPaginatorName,
            SelectType,
            StreamViewTypeType,
            TableExistsWaiterName,
            TableNotExistsWaiterName,
            TableStatusType,
            TimeToLiveStatusType,
        )
        
        def check_value(value: AttributeActionType) -> bool:
            ...
        ```
        
        ### Typed dictionaries<a id="typed-dictionaries"></a>
        
        `mypy_boto3_dynamodb.type_defs` module contains structures and shapes assembled
        to typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_dynamodb.type_defs import (
            ArchivalSummaryTypeDef,
            AttributeDefinitionTypeDef,
            AttributeValueUpdateTypeDef,
            AutoScalingPolicyDescriptionTypeDef,
            AutoScalingPolicyUpdateTypeDef,
            AutoScalingSettingsDescriptionTypeDef,
            AutoScalingSettingsUpdateTypeDef,
            AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef,
            AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef,
            BackupDescriptionTypeDef,
            BackupDetailsTypeDef,
            BackupSummaryTypeDef,
            BatchExecuteStatementOutputTypeDef,
            BatchGetItemOutputTypeDef,
            BatchStatementErrorTypeDef,
            BatchStatementRequestTypeDef,
            BatchStatementResponseTypeDef,
            BatchWriteItemOutputTypeDef,
            BillingModeSummaryTypeDef,
            CapacityTypeDef,
            ConditionCheckTypeDef,
            ConditionTypeDef,
            ConsumedCapacityTypeDef,
            ContinuousBackupsDescriptionTypeDef,
            ContributorInsightsSummaryTypeDef,
            CreateBackupOutputTypeDef,
            CreateGlobalSecondaryIndexActionTypeDef,
            CreateGlobalTableOutputTypeDef,
            CreateReplicaActionTypeDef,
            CreateReplicationGroupMemberActionTypeDef,
            CreateTableOutputTypeDef,
            DeleteBackupOutputTypeDef,
            DeleteGlobalSecondaryIndexActionTypeDef,
            DeleteItemOutputTypeDef,
            DeleteReplicaActionTypeDef,
            DeleteReplicationGroupMemberActionTypeDef,
            DeleteRequestTypeDef,
            DeleteTableOutputTypeDef,
            DeleteTypeDef,
            DescribeBackupOutputTypeDef,
            DescribeContinuousBackupsOutputTypeDef,
            DescribeContributorInsightsOutputTypeDef,
            DescribeEndpointsResponseTypeDef,
            DescribeExportOutputTypeDef,
            DescribeGlobalTableOutputTypeDef,
            DescribeGlobalTableSettingsOutputTypeDef,
            DescribeKinesisStreamingDestinationOutputTypeDef,
            DescribeLimitsOutputTypeDef,
            DescribeTableOutputTypeDef,
            DescribeTableReplicaAutoScalingOutputTypeDef,
            DescribeTimeToLiveOutputTypeDef,
            EndpointTypeDef,
            ExecuteStatementOutputTypeDef,
            ExecuteTransactionOutputTypeDef,
            ExpectedAttributeValueTypeDef,
            ExportDescriptionTypeDef,
            ExportSummaryTypeDef,
            ExportTableToPointInTimeOutputTypeDef,
            FailureExceptionTypeDef,
            GetItemOutputTypeDef,
            GetTypeDef,
            GlobalSecondaryIndexAutoScalingUpdateTypeDef,
            GlobalSecondaryIndexDescriptionTypeDef,
            GlobalSecondaryIndexInfoTypeDef,
            GlobalSecondaryIndexTypeDef,
            GlobalSecondaryIndexUpdateTypeDef,
            GlobalTableDescriptionTypeDef,
            GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef,
            GlobalTableTypeDef,
            ItemCollectionMetricsTypeDef,
            ItemResponseTypeDef,
            KeySchemaElementTypeDef,
            KeysAndAttributesTypeDef,
            KinesisDataStreamDestinationTypeDef,
            KinesisStreamingDestinationOutputTypeDef,
            ListBackupsOutputTypeDef,
            ListContributorInsightsOutputTypeDef,
            ListExportsOutputTypeDef,
            ListGlobalTablesOutputTypeDef,
            ListTablesOutputTypeDef,
            ListTagsOfResourceOutputTypeDef,
            LocalSecondaryIndexDescriptionTypeDef,
            LocalSecondaryIndexInfoTypeDef,
            LocalSecondaryIndexTypeDef,
            PaginatorConfigTypeDef,
            ParameterizedStatementTypeDef,
            PointInTimeRecoveryDescriptionTypeDef,
            PointInTimeRecoverySpecificationTypeDef,
            ProjectionTypeDef,
            ProvisionedThroughputDescriptionTypeDef,
            ProvisionedThroughputOverrideTypeDef,
            ProvisionedThroughputTypeDef,
            PutItemOutputTypeDef,
            PutRequestTypeDef,
            PutTypeDef,
            QueryOutputTypeDef,
            ReplicaAutoScalingDescriptionTypeDef,
            ReplicaAutoScalingUpdateTypeDef,
            ReplicaDescriptionTypeDef,
            ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef,
            ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef,
            ReplicaGlobalSecondaryIndexDescriptionTypeDef,
            ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef,
            ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef,
            ReplicaGlobalSecondaryIndexTypeDef,
            ReplicaSettingsDescriptionTypeDef,
            ReplicaSettingsUpdateTypeDef,
            ReplicaTypeDef,
            ReplicaUpdateTypeDef,
            ReplicationGroupUpdateTypeDef,
            ResponseMetadataTypeDef,
            RestoreSummaryTypeDef,
            RestoreTableFromBackupOutputTypeDef,
            RestoreTableToPointInTimeOutputTypeDef,
            SSEDescriptionTypeDef,
            SSESpecificationTypeDef,
            ScanOutputTypeDef,
            SourceTableDetailsTypeDef,
            SourceTableFeatureDetailsTypeDef,
            StreamSpecificationTypeDef,
            TableAutoScalingDescriptionTypeDef,
            TableDescriptionTypeDef,
            TagTypeDef,
            TimeToLiveDescriptionTypeDef,
            TimeToLiveSpecificationTypeDef,
            TransactGetItemTypeDef,
            TransactGetItemsOutputTypeDef,
            TransactWriteItemTypeDef,
            TransactWriteItemsOutputTypeDef,
            UpdateContinuousBackupsOutputTypeDef,
            UpdateContributorInsightsOutputTypeDef,
            UpdateGlobalSecondaryIndexActionTypeDef,
            UpdateGlobalTableOutputTypeDef,
            UpdateGlobalTableSettingsOutputTypeDef,
            UpdateItemOutputTypeDef,
            UpdateReplicationGroupMemberActionTypeDef,
            UpdateTableOutputTypeDef,
            UpdateTableReplicaAutoScalingOutputTypeDef,
            UpdateTimeToLiveOutputTypeDef,
            UpdateTypeDef,
            WaiterConfigTypeDef,
            WriteRequestTypeDef,
        )
        
        def get_structure() -> ArchivalSummaryTypeDef:
            return {
              ...
            }
        ```
        
        ## Versioning<a id="versioning"></a>
        
        `mypy-boto3-dynamodb` version is the same as related `boto3` version and
        follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
        
        ## Documentation<a id="documentation"></a>
        
        All type annotations can be found in
        [mypy-boto3-dynamodb docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/)
        
        ## Support and contributing<a id="support-and-contributing"></a>
        
        This package is auto-generated. Please reports any bugs or request new features
        in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
        repository.
        
Keywords: boto3 dynamodb type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
