QLDB module#
Index > QLDB
Auto-generated documentation for QLDB type annotations stubs module types-boto3-qldb.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
QLDB
service. - Use provided commands to install generated packages.
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 types-boto3
for QLDB
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[qldb]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[qldb]'
# standalone installation
python -m pip install types-boto3-qldb
How to uninstall#
python -m pip uninstall -y types-boto3-qldb
Usage#
Code samples can be found in Examples.
QLDBClient#
Type annotations and code completion for boto3.client("qldb")
as QLDBClient
boto3 documentation
# QLDBClient usage example
from boto3.session import Session
from types_boto3_qldb.client import QLDBClient
def get_client() -> QLDBClient:
return Session().client("qldb")
Literals#
Type annotations for literals used in methods and schema.
# EncryptionStatusType usage example
from types_boto3_qldb.literals import EncryptionStatusType
def get_value() -> EncryptionStatusType:
return "ENABLED"
- EncryptionStatusType
- ErrorCauseType
- ExportStatusType
- LedgerStateType
- OutputFormatType
- PermissionsModeType
- S3ObjectEncryptionTypeType
- StreamStatusType
- QLDBServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- CancelJournalKinesisStreamRequestTypeDef
- ResponseMetadataTypeDef
- CreateLedgerRequestTypeDef
- DeleteLedgerRequestTypeDef
- DescribeJournalKinesisStreamRequestTypeDef
- DescribeJournalS3ExportRequestTypeDef
- DescribeLedgerRequestTypeDef
- LedgerEncryptionDescriptionTypeDef
- TimestampTypeDef
- ValueHolderTypeDef
- GetDigestRequestTypeDef
- KinesisConfigurationTypeDef
- LedgerSummaryTypeDef
- ListJournalKinesisStreamsForLedgerRequestTypeDef
- ListJournalS3ExportsForLedgerRequestTypeDef
- ListJournalS3ExportsRequestTypeDef
- ListLedgersRequestTypeDef
- ListTagsForResourceRequestTypeDef
- S3EncryptionConfigurationTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateLedgerPermissionsModeRequestTypeDef
- UpdateLedgerRequestTypeDef
- CancelJournalKinesisStreamResponseTypeDef
- CreateLedgerResponseTypeDef
- EmptyResponseMetadataTypeDef
- ExportJournalToS3ResponseTypeDef
- ListTagsForResourceResponseTypeDef
- StreamJournalToKinesisResponseTypeDef
- UpdateLedgerPermissionsModeResponseTypeDef
- DescribeLedgerResponseTypeDef
- UpdateLedgerResponseTypeDef
- GetBlockRequestTypeDef
- GetBlockResponseTypeDef
- GetDigestResponseTypeDef
- GetRevisionRequestTypeDef
- GetRevisionResponseTypeDef
- JournalKinesisStreamDescriptionTypeDef
- StreamJournalToKinesisRequestTypeDef
- ListLedgersResponseTypeDef
- S3ExportConfigurationTypeDef
- DescribeJournalKinesisStreamResponseTypeDef
- ListJournalKinesisStreamsForLedgerResponseTypeDef
- ExportJournalToS3RequestTypeDef
- JournalS3ExportDescriptionTypeDef
- DescribeJournalS3ExportResponseTypeDef
- ListJournalS3ExportsForLedgerResponseTypeDef
- ListJournalS3ExportsResponseTypeDef