Skip to content

DynamoDB module

Index > DynamoDB

Auto-generated documentation for DynamoDB type annotations stubs module mypy-boto3-dynamodb.

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and DynamoDB.

From PyPI with pip

Install boto3-stubs for DynamoDB service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[dynamodb]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[dynamodb]'


# standalone installation
python -m pip install mypy-boto3-dynamodb

From conda-forge

Installing mypy-boto3-dynamodb from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, mypy-boto3-dynamodb can be installed with:

conda install mypy-boto3-dynamodb

It is possible to list all of the versions of mypy-boto3-dynamodb available on your platform with:

conda search mypy-boto3-dynamodb --channel conda-forge

How to uninstall

python -m pip uninstall -y mypy-boto3-dynamodb

Usage

Code samples can be found in Examples.

DynamoDBClient

Type annotations and code completion for boto3.client("dynamodb") as DynamoDBClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.client import DynamoDBClient

def get_client() -> DynamoDBClient:
    return Session().client("dynamodb")

Paginators

Type annotations and code completion for paginators from boto3.client("dynamodb").get_paginator("...").

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.paginator import ListBackupsPaginator

def get_list_backups_paginator() -> ListBackupsPaginator:
    return Session().client("dynamodb").get_paginator("list_backups"))

Waiters

Type annotations and code completion for waiters from boto3.client("dynamodb").get_waiter("...").

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.waiter import TableExistsWaiter

def get_table_exists_waiter() -> TableExistsWaiter:
    return Session().client("dynamodb").get_waiter("table_exists")

DynamoDBServiceResource

Type annotations and code completion for boto3.resource("dynamodb") as DynamoDBServiceResource boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource

def get_dynamodb_resource() -> DynamoDBServiceResource:
    return Session().resource("dynamodb")

Collections

Type annotations and code completion for collections from boto3.resource("dynamodb").*.

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.service_resource import ServiceResourceTablesCollection

def get_collection() -> ServiceResourceTablesCollection:
    return Session().resource("dynamodb").tables

Resources

Type annotations and code completion for additional resources from boto3.resource("dynamodb").*.

Usage example
from boto3.session import Session

from mypy_boto3_dynamodb.service_resource import Table

def get_resource() -> Table:
    return Session().resource("dynamodb").Table(...)

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_dynamodb.literals import AttributeActionType

def get_value() -> AttributeActionType:
    return "ADD"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_dynamodb.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }