Skip to content

DynamoDB module

Index > DynamoDB

Auto-generated documentation for DynamoDB type annotations stubs module types-aiobotocore-dynamodb.

How to install

From PyPI with pip

Install types-aioboto3 for DynamoDB service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[dynamodb]'


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


# standalone installation
python -m pip install types-aiobotocore-dynamodb

How to uninstall

python -m pip uninstall -y types-aiobotocore-dynamodb

Usage

Code samples can be found in Examples.

DynamoDBClient

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

Usage example
from aioboto3.session import Session

from types_aiobotocore_dynamodb.client import DynamoDBClient


session = Session()
async with session.client("dynamodb") as client:
    client: DynamoDBClient

Paginators

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

Usage example
from types_aiobotocore_dynamodb.paginator import ListBackupsPaginator

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

Waiters

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

Usage example
from types_aiobotocore_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 session.resource("dynamodb") as DynamoDBServiceResource boto3 documentation

Usage example
from types_aiobotocore_dynamodb.service_resource import DynamoDBServiceResource

Collections

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

Usage example
from types_aiobotocore_dynamodb.service_resource import ServiceResourceTablesCollection

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

Resources

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

Usage example
from types_aiobotocore_dynamodb.service_resource import Table

def get_resource() -> Table:
    return resource.Table(...)

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_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 types_aiobotocore_dynamodb.type_defs import ResponseMetadataTypeDef

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