QLDB module

Index > QLDB

Auto-generated documentation for QLDB type annotations stubs module mypy-boto3-qldb.

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 QLDB.

From PyPI with pip

Install boto3-stubs for QLDB service.

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


# 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[qldb]'


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

How to uninstall

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

Usage

Code samples can be found in Examples.

QLDBClient

Type annotations and code completion for boto3.client("qldb") as QLDBClient boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_qldb.client import QLDBClient

def get_client() -> QLDBClient:
    return Session().client("qldb")

Literals

Type annotations for literals used in methods and schemas.

Usage example

from mypy_boto3_qldb.literals import EncryptionStatusType

def get_value() -> EncryptionStatusType:
    return "ENABLED"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example

from mypy_boto3_qldb.type_defs import CancelJournalKinesisStreamRequestRequestTypeDef

def get_value() -> CancelJournalKinesisStreamRequestRequestTypeDef:
    return {
        "LedgerName": ...,
        "StreamId": ...,
    }