Skip to content

QLDBSessionClient#

Index > QLDBSession > QLDBSessionClient

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

QLDBSessionClient#

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

# QLDBSessionClient usage example

from boto3.session import Session
from mypy_boto3_qldb_session.client import QLDBSessionClient

def get_qldb-session_client() -> QLDBSessionClient:
    return Session().client("qldb-session")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("qldb-session")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.CapacityExceededException,
    client.exceptions.ClientError,
    client.exceptions.InvalidSessionException,
    client.exceptions.LimitExceededException,
    client.exceptions.OccConflictException,
    client.exceptions.RateExceededException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_qldb_session.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

generate_presigned_url#

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

Type annotations and code completion for boto3.client("qldb-session").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:
    ...

send_command#

Sends a command to an Amazon QLDB ledger.

Type annotations and code completion for boto3.client("qldb-session").send_command method. boto3 documentation

# send_command method definition

def send_command(
    self,
    *,
    SessionToken: str = ...,
    StartSession: StartSessionRequestTypeDef = ...,  # (1)
    StartTransaction: Mapping[str, Any] = ...,
    EndSession: Mapping[str, Any] = ...,
    CommitTransaction: CommitTransactionRequestTypeDef = ...,  # (2)
    AbortTransaction: Mapping[str, Any] = ...,
    ExecuteStatement: ExecuteStatementRequestTypeDef = ...,  # (3)
    FetchPage: FetchPageRequestTypeDef = ...,  # (4)
) -> SendCommandResultTypeDef:  # (5)
    ...
  1. See StartSessionRequestTypeDef
  2. See CommitTransactionRequestTypeDef
  3. See ExecuteStatementRequestTypeDef
  4. See FetchPageRequestTypeDef
  5. See SendCommandResultTypeDef
# send_command method usage example with argument unpacking

kwargs: SendCommandRequestRequestTypeDef = {  # (1)
    "SessionToken": ...,
}

parent.send_command(**kwargs)
  1. See SendCommandRequestRequestTypeDef