Typed dictionaries

Index > QLDBSession > Typed dictionaries

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

TimingInformationTypeDef

# TimingInformationTypeDef usage example

from mypy_boto3_qldb_session.type_defs import TimingInformationTypeDef

def get_value() -> TimingInformationTypeDef:
    return {
        "ProcessingTimeMilliseconds": ...,
    }

# TimingInformationTypeDef definition

class TimingInformationTypeDef(TypedDict):
    ProcessingTimeMilliseconds: NotRequired[int],

CommitTransactionRequestTypeDef

# CommitTransactionRequestTypeDef usage example

from mypy_boto3_qldb_session.type_defs import CommitTransactionRequestTypeDef

def get_value() -> CommitTransactionRequestTypeDef:
    return {
        "TransactionId": ...,
        "CommitDigest": ...,
    }

# CommitTransactionRequestTypeDef definition

class CommitTransactionRequestTypeDef(TypedDict):
    TransactionId: str,
    CommitDigest: Union[str, bytes, IO[Any], StreamingBody],

IOUsageTypeDef

# IOUsageTypeDef usage example

from mypy_boto3_qldb_session.type_defs import IOUsageTypeDef

def get_value() -> IOUsageTypeDef:
    return {
        "ReadIOs": ...,
    }

# IOUsageTypeDef definition

class IOUsageTypeDef(TypedDict):
    ReadIOs: NotRequired[int],
    WriteIOs: NotRequired[int],

ValueHolderTypeDef

# ValueHolderTypeDef usage example

from mypy_boto3_qldb_session.type_defs import ValueHolderTypeDef

def get_value() -> ValueHolderTypeDef:
    return {
        "IonBinary": ...,
    }

# ValueHolderTypeDef definition

class ValueHolderTypeDef(TypedDict):
    IonBinary: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    IonText: NotRequired[str],

FetchPageRequestTypeDef

# FetchPageRequestTypeDef usage example

from mypy_boto3_qldb_session.type_defs import FetchPageRequestTypeDef

def get_value() -> FetchPageRequestTypeDef:
    return {
        "TransactionId": ...,
        "NextPageToken": ...,
    }

# FetchPageRequestTypeDef definition

class FetchPageRequestTypeDef(TypedDict):
    TransactionId: str,
    NextPageToken: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_qldb_session.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

StartSessionRequestTypeDef

# StartSessionRequestTypeDef usage example

from mypy_boto3_qldb_session.type_defs import StartSessionRequestTypeDef

def get_value() -> StartSessionRequestTypeDef:
    return {
        "LedgerName": ...,
    }

# StartSessionRequestTypeDef definition

class StartSessionRequestTypeDef(TypedDict):
    LedgerName: str,

AbortTransactionResultTypeDef

# AbortTransactionResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import AbortTransactionResultTypeDef

def get_value() -> AbortTransactionResultTypeDef:
    return {
        "TimingInformation": ...,
    }

# AbortTransactionResultTypeDef definition

class AbortTransactionResultTypeDef(TypedDict):
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (1)

1. See TimingInformationTypeDef

EndSessionResultTypeDef

# EndSessionResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import EndSessionResultTypeDef

def get_value() -> EndSessionResultTypeDef:
    return {
        "TimingInformation": ...,
    }

# EndSessionResultTypeDef definition

class EndSessionResultTypeDef(TypedDict):
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (1)

1. See TimingInformationTypeDef

StartSessionResultTypeDef

# StartSessionResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import StartSessionResultTypeDef

def get_value() -> StartSessionResultTypeDef:
    return {
        "SessionToken": ...,
    }

# StartSessionResultTypeDef definition

class StartSessionResultTypeDef(TypedDict):
    SessionToken: NotRequired[str],
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (1)

1. See TimingInformationTypeDef

StartTransactionResultTypeDef

# StartTransactionResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import StartTransactionResultTypeDef

def get_value() -> StartTransactionResultTypeDef:
    return {
        "TransactionId": ...,
    }

# StartTransactionResultTypeDef definition

class StartTransactionResultTypeDef(TypedDict):
    TransactionId: NotRequired[str],
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (1)

1. See TimingInformationTypeDef

CommitTransactionResultTypeDef

# CommitTransactionResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import CommitTransactionResultTypeDef

def get_value() -> CommitTransactionResultTypeDef:
    return {
        "TransactionId": ...,
    }

# CommitTransactionResultTypeDef definition

class CommitTransactionResultTypeDef(TypedDict):
    TransactionId: NotRequired[str],
    CommitDigest: NotRequired[bytes],
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (1)
    ConsumedIOs: NotRequired[IOUsageTypeDef],  # (2)

1. See TimingInformationTypeDef
2. See IOUsageTypeDef

ExecuteStatementRequestTypeDef

# ExecuteStatementRequestTypeDef usage example

from mypy_boto3_qldb_session.type_defs import ExecuteStatementRequestTypeDef

def get_value() -> ExecuteStatementRequestTypeDef:
    return {
        "TransactionId": ...,
        "Statement": ...,
    }

# ExecuteStatementRequestTypeDef definition

class ExecuteStatementRequestTypeDef(TypedDict):
    TransactionId: str,
    Statement: str,
    Parameters: NotRequired[Sequence[ValueHolderTypeDef]],  # (1)

1. See ValueHolderTypeDef

PageTypeDef

# PageTypeDef usage example

from mypy_boto3_qldb_session.type_defs import PageTypeDef

def get_value() -> PageTypeDef:
    return {
        "Values": ...,
    }

# PageTypeDef definition

class PageTypeDef(TypedDict):
    Values: NotRequired[List[ValueHolderTypeDef]],  # (1)
    NextPageToken: NotRequired[str],

1. See ValueHolderTypeDef

SendCommandRequestRequestTypeDef

# SendCommandRequestRequestTypeDef usage example

from mypy_boto3_qldb_session.type_defs import SendCommandRequestRequestTypeDef

def get_value() -> SendCommandRequestRequestTypeDef:
    return {
        "SessionToken": ...,
    }

# SendCommandRequestRequestTypeDef definition

class SendCommandRequestRequestTypeDef(TypedDict):
    SessionToken: NotRequired[str],
    StartSession: NotRequired[StartSessionRequestTypeDef],  # (1)
    StartTransaction: NotRequired[Mapping[str, Any]],
    EndSession: NotRequired[Mapping[str, Any]],
    CommitTransaction: NotRequired[CommitTransactionRequestTypeDef],  # (2)
    AbortTransaction: NotRequired[Mapping[str, Any]],
    ExecuteStatement: NotRequired[ExecuteStatementRequestTypeDef],  # (3)
    FetchPage: NotRequired[FetchPageRequestTypeDef],  # (4)

1. See StartSessionRequestTypeDef
2. See CommitTransactionRequestTypeDef
3. See ExecuteStatementRequestTypeDef
4. See FetchPageRequestTypeDef

ExecuteStatementResultTypeDef

# ExecuteStatementResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import ExecuteStatementResultTypeDef

def get_value() -> ExecuteStatementResultTypeDef:
    return {
        "FirstPage": ...,
    }

# ExecuteStatementResultTypeDef definition

class ExecuteStatementResultTypeDef(TypedDict):
    FirstPage: NotRequired[PageTypeDef],  # (1)
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (2)
    ConsumedIOs: NotRequired[IOUsageTypeDef],  # (3)

1. See PageTypeDef
2. See TimingInformationTypeDef
3. See IOUsageTypeDef

FetchPageResultTypeDef

# FetchPageResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import FetchPageResultTypeDef

def get_value() -> FetchPageResultTypeDef:
    return {
        "Page": ...,
    }

# FetchPageResultTypeDef definition

class FetchPageResultTypeDef(TypedDict):
    Page: NotRequired[PageTypeDef],  # (1)
    TimingInformation: NotRequired[TimingInformationTypeDef],  # (2)
    ConsumedIOs: NotRequired[IOUsageTypeDef],  # (3)

1. See PageTypeDef
2. See TimingInformationTypeDef
3. See IOUsageTypeDef

SendCommandResultTypeDef

# SendCommandResultTypeDef usage example

from mypy_boto3_qldb_session.type_defs import SendCommandResultTypeDef

def get_value() -> SendCommandResultTypeDef:
    return {
        "StartSession": ...,
        "StartTransaction": ...,
        "EndSession": ...,
        "CommitTransaction": ...,
        "AbortTransaction": ...,
        "ExecuteStatement": ...,
        "FetchPage": ...,
        "ResponseMetadata": ...,
    }

# SendCommandResultTypeDef definition

class SendCommandResultTypeDef(TypedDict):
    StartSession: StartSessionResultTypeDef,  # (1)
    StartTransaction: StartTransactionResultTypeDef,  # (2)
    EndSession: EndSessionResultTypeDef,  # (3)
    CommitTransaction: CommitTransactionResultTypeDef,  # (4)
    AbortTransaction: AbortTransactionResultTypeDef,  # (5)
    ExecuteStatement: ExecuteStatementResultTypeDef,  # (6)
    FetchPage: FetchPageResultTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)

1. See StartSessionResultTypeDef
2. See StartTransactionResultTypeDef
3. See EndSessionResultTypeDef
4. See CommitTransactionResultTypeDef
5. See AbortTransactionResultTypeDef
6. See ExecuteStatementResultTypeDef
7. See FetchPageResultTypeDef
8. See ResponseMetadataTypeDef