Skip to content

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

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.

Usage example
client = boto3.client("qldb")

try:
    do_something(client)
except (
    client.ClientError,
    client.InvalidParameterException,
    client.LimitExceededException,
    client.ResourceAlreadyExistsException,
    client.ResourceInUseException,
    client.ResourceNotFoundException,
    client.ResourcePreconditionNotMetException,
) as e:
    print(e)
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

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

Method definition
def cancel_journal_kinesis_stream(
    self,
    *,
    LedgerName: str,
    StreamId: str,
) -> CancelJournalKinesisStreamResponseTypeDef:  # (1)
    ...
  1. See CancelJournalKinesisStreamResponseTypeDef
Usage example with kwargs
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

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

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
Usage example with kwargs
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

Method definition
def delete_ledger(
    self,
    *,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def describe_journal_kinesis_stream(
    self,
    *,
    LedgerName: str,
    StreamId: str,
) -> DescribeJournalKinesisStreamResponseTypeDef:  # (1)
    ...
  1. See DescribeJournalKinesisStreamResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_journal_s3_export(
    self,
    *,
    Name: str,
    ExportId: str,
) -> DescribeJournalS3ExportResponseTypeDef:  # (1)
    ...
  1. See DescribeJournalS3ExportResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_ledger(
    self,
    *,
    Name: str,
) -> DescribeLedgerResponseTypeDef:  # (1)
    ...
  1. See DescribeLedgerResponseTypeDef
Usage example with kwargs
kwargs: DescribeLedgerRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_ledger(**kwargs)
  1. See DescribeLedgerRequestRequestTypeDef

export_journal_to_s3

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.

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

Method definition
def export_journal_to_s3(
    self,
    *,
    Name: str,
    InclusiveStartTime: Union[datetime, str],
    ExclusiveEndTime: Union[datetime, str],
    S3ExportConfiguration: S3ExportConfigurationTypeDef,  # (1)
    RoleArn: str,
    OutputFormat: OutputFormatType = ...,  # (2)
) -> ExportJournalToS3ResponseTypeDef:  # (3)
    ...
  1. See S3ExportConfigurationTypeDef
  2. See OutputFormatType
  3. See ExportJournalToS3ResponseTypeDef
Usage example with kwargs
kwargs: ExportJournalToS3RequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InclusiveStartTime": ...,
    "ExclusiveEndTime": ...,
    "S3ExportConfiguration": ...,
    "RoleArn": ...,
}

parent.export_journal_to_s3(**kwargs)
  1. See ExportJournalToS3RequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_block

Returns a block object at a specified address in a journal.

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

Method definition
def get_block(
    self,
    *,
    Name: str,
    BlockAddress: ValueHolderTypeDef,  # (1)
    DigestTipAddress: ValueHolderTypeDef = ...,  # (1)
) -> GetBlockResponseTypeDef:  # (3)
    ...
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef
  3. See GetBlockResponseTypeDef
Usage example with kwargs
kwargs: GetBlockRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "BlockAddress": ...,
}

parent.get_block(**kwargs)
  1. See GetBlockRequestRequestTypeDef

get_digest

Returns the digest of a ledger at the latest committed block in the journal.

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

Method definition
def get_digest(
    self,
    *,
    Name: str,
) -> GetDigestResponseTypeDef:  # (1)
    ...
  1. See GetDigestResponseTypeDef
Usage example with kwargs
kwargs: GetDigestRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_digest(**kwargs)
  1. See GetDigestRequestRequestTypeDef

get_revision

Returns a revision data object for a specified document ID and block address.

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

Method definition
def get_revision(
    self,
    *,
    Name: str,
    BlockAddress: ValueHolderTypeDef,  # (1)
    DocumentId: str,
    DigestTipAddress: ValueHolderTypeDef = ...,  # (1)
) -> GetRevisionResponseTypeDef:  # (3)
    ...
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef
  3. See GetRevisionResponseTypeDef
Usage example with kwargs
kwargs: GetRevisionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "BlockAddress": ...,
    "DocumentId": ...,
}

parent.get_revision(**kwargs)
  1. See GetRevisionRequestRequestTypeDef

list_journal_kinesis_streams_for_ledger

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.

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

Method definition
def list_journal_kinesis_streams_for_ledger(
    self,
    *,
    LedgerName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalKinesisStreamsForLedgerResponseTypeDef:  # (1)
    ...
  1. See ListJournalKinesisStreamsForLedgerResponseTypeDef
Usage example with kwargs
kwargs: ListJournalKinesisStreamsForLedgerRequestRequestTypeDef = {  # (1)
    "LedgerName": ...,
}

parent.list_journal_kinesis_streams_for_ledger(**kwargs)
  1. See ListJournalKinesisStreamsForLedgerRequestRequestTypeDef

list_journal_s3_exports

Returns an array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

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

Method definition
def list_journal_s3_exports(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalS3ExportsResponseTypeDef:  # (1)
    ...
  1. See ListJournalS3ExportsResponseTypeDef
Usage example with kwargs
kwargs: ListJournalS3ExportsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_journal_s3_exports(**kwargs)
  1. See ListJournalS3ExportsRequestRequestTypeDef

list_journal_s3_exports_for_ledger

Returns an array of journal export job descriptions for a specified ledger.

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

Method definition
def list_journal_s3_exports_for_ledger(
    self,
    *,
    Name: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalS3ExportsForLedgerResponseTypeDef:  # (1)
    ...
  1. See ListJournalS3ExportsForLedgerResponseTypeDef
Usage example with kwargs
kwargs: ListJournalS3ExportsForLedgerRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.list_journal_s3_exports_for_ledger(**kwargs)
  1. See ListJournalS3ExportsForLedgerRequestRequestTypeDef

list_ledgers

Returns an array of ledger summaries that are associated with the current Amazon Web Services account and Region.

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

Method definition
def list_ledgers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLedgersResponseTypeDef:  # (1)
    ...
  1. See ListLedgersResponseTypeDef
Usage example with kwargs
kwargs: ListLedgersRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_ledgers(**kwargs)
  1. See ListLedgersRequestRequestTypeDef

list_tags_for_resource

Returns all tags for a specified Amazon QLDB resource.

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

stream_journal_to_kinesis

Creates a journal stream for a given Amazon QLDB ledger.

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

Method definition
def stream_journal_to_kinesis(
    self,
    *,
    LedgerName: str,
    RoleArn: str,
    InclusiveStartTime: Union[datetime, str],
    KinesisConfiguration: KinesisConfigurationTypeDef,  # (1)
    StreamName: str,
    Tags: Mapping[str, str] = ...,
    ExclusiveEndTime: Union[datetime, str] = ...,
) -> StreamJournalToKinesisResponseTypeDef:  # (2)
    ...
  1. See KinesisConfigurationTypeDef
  2. See StreamJournalToKinesisResponseTypeDef
Usage example with kwargs
kwargs: StreamJournalToKinesisRequestRequestTypeDef = {  # (1)
    "LedgerName": ...,
    "RoleArn": ...,
    "InclusiveStartTime": ...,
    "KinesisConfiguration": ...,
    "StreamName": ...,
}

parent.stream_journal_to_kinesis(**kwargs)
  1. See StreamJournalToKinesisRequestRequestTypeDef

tag_resource

Adds one or more tags to a specified Amazon QLDB resource.

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from a specified Amazon QLDB resource.

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_ledger

Updates properties on a ledger.

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

Method definition
def update_ledger(
    self,
    *,
    Name: str,
    DeletionProtection: bool = ...,
    KmsKey: str = ...,
) -> UpdateLedgerResponseTypeDef:  # (1)
    ...
  1. See UpdateLedgerResponseTypeDef
Usage example with kwargs
kwargs: UpdateLedgerRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_ledger(**kwargs)
  1. See UpdateLedgerRequestRequestTypeDef

update_ledger_permissions_mode

Updates the permissions mode of a ledger.

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

Method definition
def update_ledger_permissions_mode(
    self,
    *,
    Name: str,
    PermissionsMode: PermissionsModeType,  # (1)
) -> UpdateLedgerPermissionsModeResponseTypeDef:  # (2)
    ...
  1. See PermissionsModeType
  2. See UpdateLedgerPermissionsModeResponseTypeDef
Usage example with kwargs
kwargs: UpdateLedgerPermissionsModeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PermissionsMode": ...,
}

parent.update_ledger_permissions_mode(**kwargs)
  1. See UpdateLedgerPermissionsModeRequestRequestTypeDef