QLDBClient

Index > QLDB > QLDBClient

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

QLDBClient

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

# QLDBClient usage example

from boto3.session import Session
from mypy_boto3_qldb.client import QLDBClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("qldb").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("qldb")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InvalidParameterException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourcePreconditionNotMetException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_qldb.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("qldb").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_journal_kinesis_stream

Ends a given Amazon QLDB journal stream.

Type annotations and code completion for boto3.client("qldb").cancel_journal_kinesis_stream method. boto3 documentation

# cancel_journal_kinesis_stream method definition

def cancel_journal_kinesis_stream(
    self,
    *,
    LedgerName: str,
    StreamId: str,
) -> CancelJournalKinesisStreamResponseTypeDef:  # (1)
    ...

1. See CancelJournalKinesisStreamResponseTypeDef

# cancel_journal_kinesis_stream method usage example with argument unpacking

kwargs: CancelJournalKinesisStreamRequestRequestTypeDef = {  # (1)
    "LedgerName": ...,
    "StreamId": ...,
}

parent.cancel_journal_kinesis_stream(**kwargs)

1. See CancelJournalKinesisStreamRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("qldb").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_ledger

Creates a new ledger in your Amazon Web Services account in the current Region.

Type annotations and code completion for boto3.client("qldb").create_ledger method. boto3 documentation

# create_ledger method definition

def create_ledger(
    self,
    *,
    Name: str,
    PermissionsMode: PermissionsModeType,  # (1)
    Tags: Mapping[str, str] = ...,
    DeletionProtection: bool = ...,
    KmsKey: str = ...,
) -> CreateLedgerResponseTypeDef:  # (2)
    ...

1. See PermissionsModeType
2. See CreateLedgerResponseTypeDef

# create_ledger method usage example with argument unpacking

kwargs: CreateLedgerRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PermissionsMode": ...,
}

parent.create_ledger(**kwargs)

1. See CreateLedgerRequestRequestTypeDef

delete_ledger

Deletes a ledger and all of its contents.

Type annotations and code completion for boto3.client("qldb").delete_ledger method. boto3 documentation

# delete_ledger method definition

def delete_ledger(
    self,
    *,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_ledger method usage example with argument unpacking

kwargs: DeleteLedgerRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_ledger(**kwargs)

1. See DeleteLedgerRequestRequestTypeDef

describe_journal_kinesis_stream

Returns detailed information about a given Amazon QLDB journal stream.

Type annotations and code completion for boto3.client("qldb").describe_journal_kinesis_stream method. boto3 documentation

# describe_journal_kinesis_stream method definition

def describe_journal_kinesis_stream(
    self,
    *,
    LedgerName: str,
    StreamId: str,
) -> DescribeJournalKinesisStreamResponseTypeDef:  # (1)
    ...

1. See DescribeJournalKinesisStreamResponseTypeDef

# describe_journal_kinesis_stream method usage example with argument unpacking

kwargs: DescribeJournalKinesisStreamRequestRequestTypeDef = {  # (1)
    "LedgerName": ...,
    "StreamId": ...,
}

parent.describe_journal_kinesis_stream(**kwargs)

1. See DescribeJournalKinesisStreamRequestRequestTypeDef

describe_journal_s3_export

Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

Type annotations and code completion for boto3.client("qldb").describe_journal_s3_export method. boto3 documentation

# describe_journal_s3_export method definition

def describe_journal_s3_export(
    self,
    *,
    Name: str,
    ExportId: str,
) -> DescribeJournalS3ExportResponseTypeDef:  # (1)
    ...

1. See DescribeJournalS3ExportResponseTypeDef

# describe_journal_s3_export method usage example with argument unpacking

kwargs: DescribeJournalS3ExportRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ExportId": ...,
}

parent.describe_journal_s3_export(**kwargs)

1. See DescribeJournalS3ExportRequestRequestTypeDef

describe_ledger

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

Type annotations and code completion for boto3.client("qldb").describe_ledger method. boto3 documentation

# describe_ledger method definition

def describe_ledger(
    self,
    *,
    Name: str,
) -> DescribeLedgerResponseTypeDef:  # (1)
    ...

1. See