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

# 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#

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

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

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 DescribeLedgerResponseTypeDef 
# describe_ledger method usage example with argument unpacking

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

# export_journal_to_s3 method definition

def export_journal_to_s3(
    self,
    *,
    Name: str,
    InclusiveStartTime: TimestampTypeDef,
    ExclusiveEndTime: TimestampTypeDef,
    S3ExportConfiguration: S3ExportConfigurationTypeDef,  # (1)
    RoleArn: str,
    OutputFormat: OutputFormatType = ...,  # (2)
) -> ExportJournalToS3ResponseTypeDef:  # (3)
    ...
  1. See S3ExportConfigurationTypeDef
  2. See OutputFormatType
  3. See ExportJournalToS3ResponseTypeDef 
# export_journal_to_s3 method usage example with argument unpacking

kwargs: ExportJournalToS3RequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InclusiveStartTime": ...,
    "ExclusiveEndTime": ...,
    "S3ExportConfiguration": ...,
    "RoleArn": ...,
}

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

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

# get_block 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 
# get_block method usage example with argument unpacking

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

# get_digest method definition

def get_digest(
    self,
    *,
    Name: str,
) -> GetDigestResponseTypeDef:  # (1)
    ...
  1. See GetDigestResponseTypeDef 
# get_digest method usage example with argument unpacking

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

# get_revision 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 
# get_revision method usage example with argument unpacking

kwargs: GetRevisionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "BlockAddress": ...,
    "DocumentId": ...,
}

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

list_journal_kinesis_streams_for_ledger#

Returns all Amazon QLDB journal streams for a given ledger.

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

# list_journal_kinesis_streams_for_ledger method definition

def list_journal_kinesis_streams_for_ledger(
    self,
    *,
    LedgerName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalKinesisStreamsForLedgerResponseTypeDef:  # (1)
    ...
  1. See ListJournalKinesisStreamsForLedgerResponseTypeDef 
# list_journal_kinesis_streams_for_ledger method usage example with argument unpacking

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

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

list_journal_s3_exports#

Returns all journal export jobs 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

# list_journal_s3_exports method definition

def list_journal_s3_exports(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalS3ExportsResponseTypeDef:  # (1)
    ...
  1. See ListJournalS3ExportsResponseTypeDef 
# list_journal_s3_exports method usage example with argument unpacking

kwargs: ListJournalS3ExportsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

list_journal_s3_exports_for_ledger#

Returns all journal export jobs for a specified ledger.

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

# list_journal_s3_exports_for_ledger method definition

def list_journal_s3_exports_for_ledger(
    self,
    *,
    Name: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJournalS3ExportsForLedgerResponseTypeDef:  # (1)
    ...
  1. See ListJournalS3ExportsForLedgerResponseTypeDef 
# list_journal_s3_exports_for_ledger method usage example with argument unpacking

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

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

list_ledgers#

Returns all ledgers 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

# list_ledgers method definition

def list_ledgers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLedgersResponseTypeDef:  # (1)
    ...
  1. See ListLedgersResponseTypeDef 
# list_ledgers method usage example with argument unpacking

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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

# stream_journal_to_kinesis method definition

def stream_journal_to_kinesis(
    self,
    *,
    LedgerName: str,
    RoleArn: str,
    InclusiveStartTime: TimestampTypeDef,
    KinesisConfiguration: KinesisConfigurationTypeDef,  # (1)
    StreamName: str,
    Tags: Mapping[str, str] = ...,
    ExclusiveEndTime: TimestampTypeDef = ...,
) -> StreamJournalToKinesisResponseTypeDef:  # (2)
    ...
  1. See KinesisConfigurationTypeDef
  2. See StreamJournalToKinesisResponseTypeDef 
# stream_journal_to_kinesis method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

# update_ledger method definition

def update_ledger(
    self,
    *,
    Name: str,
    DeletionProtection: bool = ...,
    KmsKey: str = ...,
) -> UpdateLedgerResponseTypeDef:  # (1)
    ...
  1. See UpdateLedgerResponseTypeDef 
# update_ledger method usage example with argument unpacking

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

# update_ledger_permissions_mode method definition

def update_ledger_permissions_mode(
    self,
    *,
    Name: str,
    PermissionsMode: PermissionsModeType,  # (1)
) -> UpdateLedgerPermissionsModeResponseTypeDef:  # (2)
    ...
  1. See PermissionsModeType
  2. See UpdateLedgerPermissionsModeResponseTypeDef 
# update_ledger_permissions_mode method usage example with argument unpacking

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

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