Skip to content

Typed dictionaries#

Index > QLDB > Typed dictionaries

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

CancelJournalKinesisStreamRequestRequestTypeDef#

# CancelJournalKinesisStreamRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import CancelJournalKinesisStreamRequestRequestTypeDef

def get_value() -> CancelJournalKinesisStreamRequestRequestTypeDef:
    return {
        "LedgerName": ...,
        "StreamId": ...,
    }
# CancelJournalKinesisStreamRequestRequestTypeDef definition

class CancelJournalKinesisStreamRequestRequestTypeDef(TypedDict):
    LedgerName: str,
    StreamId: str,

CancelJournalKinesisStreamResponseTypeDef#

# CancelJournalKinesisStreamResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import CancelJournalKinesisStreamResponseTypeDef

def get_value() -> CancelJournalKinesisStreamResponseTypeDef:
    return {
        "StreamId": ...,
        "ResponseMetadata": ...,
    }
# CancelJournalKinesisStreamResponseTypeDef definition

class CancelJournalKinesisStreamResponseTypeDef(TypedDict):
    StreamId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLedgerRequestRequestTypeDef#

# CreateLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import CreateLedgerRequestRequestTypeDef

def get_value() -> CreateLedgerRequestRequestTypeDef:
    return {
        "Name": ...,
        "PermissionsMode": ...,
    }
# CreateLedgerRequestRequestTypeDef definition

class CreateLedgerRequestRequestTypeDef(TypedDict):
    Name: str,
    PermissionsMode: PermissionsModeType,  # (1)
    Tags: NotRequired[Mapping[str, str]],
    DeletionProtection: NotRequired[bool],
    KmsKey: NotRequired[str],
  1. See PermissionsModeType

CreateLedgerResponseTypeDef#

# CreateLedgerResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import CreateLedgerResponseTypeDef

def get_value() -> CreateLedgerResponseTypeDef:
    return {
        "Name": ...,
        "Arn": ...,
        "State": ...,
        "CreationDateTime": ...,
        "PermissionsMode": ...,
        "DeletionProtection": ...,
        "KmsKeyArn": ...,
        "ResponseMetadata": ...,
    }
# CreateLedgerResponseTypeDef definition

class CreateLedgerResponseTypeDef(TypedDict):
    Name: str,
    Arn: str,
    State: LedgerStateType,  # (1)
    CreationDateTime: datetime,
    PermissionsMode: PermissionsModeType,  # (2)
    DeletionProtection: bool,
    KmsKeyArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LedgerStateType
  2. See PermissionsModeType
  3. See ResponseMetadataTypeDef

DeleteLedgerRequestRequestTypeDef#

# DeleteLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import DeleteLedgerRequestRequestTypeDef

def get_value() -> DeleteLedgerRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# DeleteLedgerRequestRequestTypeDef definition

class DeleteLedgerRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeJournalKinesisStreamRequestRequestTypeDef#

# DescribeJournalKinesisStreamRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeJournalKinesisStreamRequestRequestTypeDef

def get_value() -> DescribeJournalKinesisStreamRequestRequestTypeDef:
    return {
        "LedgerName": ...,
        "StreamId": ...,
    }
# DescribeJournalKinesisStreamRequestRequestTypeDef definition

class DescribeJournalKinesisStreamRequestRequestTypeDef(TypedDict):
    LedgerName: str,
    StreamId: str,

DescribeJournalS3ExportRequestRequestTypeDef#

# DescribeJournalS3ExportRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeJournalS3ExportRequestRequestTypeDef

def get_value() -> DescribeJournalS3ExportRequestRequestTypeDef:
    return {
        "Name": ...,
        "ExportId": ...,
    }
# DescribeJournalS3ExportRequestRequestTypeDef definition

class DescribeJournalS3ExportRequestRequestTypeDef(TypedDict):
    Name: str,
    ExportId: str,

DescribeLedgerRequestRequestTypeDef#

# DescribeLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeLedgerRequestRequestTypeDef

def get_value() -> DescribeLedgerRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# DescribeLedgerRequestRequestTypeDef definition

class DescribeLedgerRequestRequestTypeDef(TypedDict):
    Name: str,

LedgerEncryptionDescriptionTypeDef#

# LedgerEncryptionDescriptionTypeDef usage example

from mypy_boto3_qldb.type_defs import LedgerEncryptionDescriptionTypeDef

def get_value() -> LedgerEncryptionDescriptionTypeDef:
    return {
        "KmsKeyArn": ...,
        "EncryptionStatus": ...,
    }
# LedgerEncryptionDescriptionTypeDef definition

class LedgerEncryptionDescriptionTypeDef(TypedDict):
    KmsKeyArn: str,
    EncryptionStatus: EncryptionStatusType,  # (1)
    InaccessibleKmsKeyDateTime: NotRequired[datetime],
  1. See EncryptionStatusType

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_qldb.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportJournalToS3ResponseTypeDef#

# ExportJournalToS3ResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ExportJournalToS3ResponseTypeDef

def get_value() -> ExportJournalToS3ResponseTypeDef:
    return {
        "ExportId": ...,
        "ResponseMetadata": ...,
    }
# ExportJournalToS3ResponseTypeDef definition

class ExportJournalToS3ResponseTypeDef(TypedDict):
    ExportId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ValueHolderTypeDef#

# ValueHolderTypeDef usage example

from mypy_boto3_qldb.type_defs import ValueHolderTypeDef

def get_value() -> ValueHolderTypeDef:
    return {
        "IonText": ...,
    }
# ValueHolderTypeDef definition

class ValueHolderTypeDef(TypedDict):
    IonText: NotRequired[str],

GetDigestRequestRequestTypeDef#

# GetDigestRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import GetDigestRequestRequestTypeDef

def get_value() -> GetDigestRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# GetDigestRequestRequestTypeDef definition

class GetDigestRequestRequestTypeDef(TypedDict):
    Name: str,

KinesisConfigurationTypeDef#

# KinesisConfigurationTypeDef usage example

from mypy_boto3_qldb.type_defs import KinesisConfigurationTypeDef

def get_value() -> KinesisConfigurationTypeDef:
    return {
        "StreamArn": ...,
    }
# KinesisConfigurationTypeDef definition

class KinesisConfigurationTypeDef(TypedDict):
    StreamArn: str,
    AggregationEnabled: NotRequired[bool],

LedgerSummaryTypeDef#

# LedgerSummaryTypeDef usage example

from mypy_boto3_qldb.type_defs import LedgerSummaryTypeDef

def get_value() -> LedgerSummaryTypeDef:
    return {
        "Name": ...,
    }
# LedgerSummaryTypeDef definition

class LedgerSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    State: NotRequired[LedgerStateType],  # (1)
    CreationDateTime: NotRequired[datetime],
  1. See LedgerStateType

ListJournalKinesisStreamsForLedgerRequestRequestTypeDef#

# ListJournalKinesisStreamsForLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalKinesisStreamsForLedgerRequestRequestTypeDef

def get_value() -> ListJournalKinesisStreamsForLedgerRequestRequestTypeDef:
    return {
        "LedgerName": ...,
    }
# ListJournalKinesisStreamsForLedgerRequestRequestTypeDef definition

class ListJournalKinesisStreamsForLedgerRequestRequestTypeDef(TypedDict):
    LedgerName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListJournalS3ExportsForLedgerRequestRequestTypeDef#

# ListJournalS3ExportsForLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalS3ExportsForLedgerRequestRequestTypeDef

def get_value() -> ListJournalS3ExportsForLedgerRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# ListJournalS3ExportsForLedgerRequestRequestTypeDef definition

class ListJournalS3ExportsForLedgerRequestRequestTypeDef(TypedDict):
    Name: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListJournalS3ExportsRequestRequestTypeDef#

# ListJournalS3ExportsRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalS3ExportsRequestRequestTypeDef

def get_value() -> ListJournalS3ExportsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListJournalS3ExportsRequestRequestTypeDef definition

class ListJournalS3ExportsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListLedgersRequestRequestTypeDef#

# ListLedgersRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ListLedgersRequestRequestTypeDef

def get_value() -> ListLedgersRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListLedgersRequestRequestTypeDef definition

class ListLedgersRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_qldb.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,

S3EncryptionConfigurationTypeDef#

# S3EncryptionConfigurationTypeDef usage example

from mypy_boto3_qldb.type_defs import S3EncryptionConfigurationTypeDef

def get_value() -> S3EncryptionConfigurationTypeDef:
    return {
        "ObjectEncryptionType": ...,
    }
# S3EncryptionConfigurationTypeDef definition

class S3EncryptionConfigurationTypeDef(TypedDict):
    ObjectEncryptionType: S3ObjectEncryptionTypeType,  # (1)
    KmsKeyArn: NotRequired[str],
  1. See S3ObjectEncryptionTypeType

StreamJournalToKinesisResponseTypeDef#

# StreamJournalToKinesisResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import StreamJournalToKinesisResponseTypeDef

def get_value() -> StreamJournalToKinesisResponseTypeDef:
    return {
        "StreamId": ...,
        "ResponseMetadata": ...,
    }
# StreamJournalToKinesisResponseTypeDef definition

class StreamJournalToKinesisResponseTypeDef(TypedDict):
    StreamId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateLedgerPermissionsModeRequestRequestTypeDef#

# UpdateLedgerPermissionsModeRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import UpdateLedgerPermissionsModeRequestRequestTypeDef

def get_value() -> UpdateLedgerPermissionsModeRequestRequestTypeDef:
    return {
        "Name": ...,
        "PermissionsMode": ...,
    }
# UpdateLedgerPermissionsModeRequestRequestTypeDef definition

class UpdateLedgerPermissionsModeRequestRequestTypeDef(TypedDict):
    Name: str,
    PermissionsMode: PermissionsModeType,  # (1)
  1. See PermissionsModeType

UpdateLedgerPermissionsModeResponseTypeDef#

# UpdateLedgerPermissionsModeResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import UpdateLedgerPermissionsModeResponseTypeDef

def get_value() -> UpdateLedgerPermissionsModeResponseTypeDef:
    return {
        "Name": ...,
        "Arn": ...,
        "PermissionsMode": ...,
        "ResponseMetadata": ...,
    }
# UpdateLedgerPermissionsModeResponseTypeDef definition

class UpdateLedgerPermissionsModeResponseTypeDef(TypedDict):
    Name: str,
    Arn: str,
    PermissionsMode: PermissionsModeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionsModeType
  2. See ResponseMetadataTypeDef

UpdateLedgerRequestRequestTypeDef#

# UpdateLedgerRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import UpdateLedgerRequestRequestTypeDef

def get_value() -> UpdateLedgerRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# UpdateLedgerRequestRequestTypeDef definition

class UpdateLedgerRequestRequestTypeDef(TypedDict):
    Name: str,
    DeletionProtection: NotRequired[bool],
    KmsKey: NotRequired[str],

DescribeLedgerResponseTypeDef#

# DescribeLedgerResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeLedgerResponseTypeDef

def get_value() -> DescribeLedgerResponseTypeDef:
    return {
        "Name": ...,
        "Arn": ...,
        "State": ...,
        "CreationDateTime": ...,
        "PermissionsMode": ...,
        "DeletionProtection": ...,
        "EncryptionDescription": ...,
        "ResponseMetadata": ...,
    }
# DescribeLedgerResponseTypeDef definition

class DescribeLedgerResponseTypeDef(TypedDict):
    Name: str,
    Arn: str,
    State: LedgerStateType,  # (1)
    CreationDateTime: datetime,
    PermissionsMode: PermissionsModeType,  # (2)
    DeletionProtection: bool,
    EncryptionDescription: LedgerEncryptionDescriptionTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See LedgerStateType
  2. See PermissionsModeType
  3. See LedgerEncryptionDescriptionTypeDef
  4. See ResponseMetadataTypeDef

UpdateLedgerResponseTypeDef#

# UpdateLedgerResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import UpdateLedgerResponseTypeDef

def get_value() -> UpdateLedgerResponseTypeDef:
    return {
        "Name": ...,
        "Arn": ...,
        "State": ...,
        "CreationDateTime": ...,
        "DeletionProtection": ...,
        "EncryptionDescription": ...,
        "ResponseMetadata": ...,
    }
# UpdateLedgerResponseTypeDef definition

class UpdateLedgerResponseTypeDef(TypedDict):
    Name: str,
    Arn: str,
    State: LedgerStateType,  # (1)
    CreationDateTime: datetime,
    DeletionProtection: bool,
    EncryptionDescription: LedgerEncryptionDescriptionTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LedgerStateType
  2. See LedgerEncryptionDescriptionTypeDef
  3. See ResponseMetadataTypeDef

GetBlockRequestRequestTypeDef#

# GetBlockRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import GetBlockRequestRequestTypeDef

def get_value() -> GetBlockRequestRequestTypeDef:
    return {
        "Name": ...,
        "BlockAddress": ...,
    }
# GetBlockRequestRequestTypeDef definition

class GetBlockRequestRequestTypeDef(TypedDict):
    Name: str,
    BlockAddress: ValueHolderTypeDef,  # (1)
    DigestTipAddress: NotRequired[ValueHolderTypeDef],  # (1)
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef

GetBlockResponseTypeDef#

# GetBlockResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import GetBlockResponseTypeDef

def get_value() -> GetBlockResponseTypeDef:
    return {
        "Block": ...,
        "Proof": ...,
        "ResponseMetadata": ...,
    }
# GetBlockResponseTypeDef definition

class GetBlockResponseTypeDef(TypedDict):
    Block: ValueHolderTypeDef,  # (1)
    Proof: ValueHolderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef
  3. See ResponseMetadataTypeDef

GetDigestResponseTypeDef#

# GetDigestResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import GetDigestResponseTypeDef

def get_value() -> GetDigestResponseTypeDef:
    return {
        "Digest": ...,
        "DigestTipAddress": ...,
        "ResponseMetadata": ...,
    }
# GetDigestResponseTypeDef definition

class GetDigestResponseTypeDef(TypedDict):
    Digest: bytes,
    DigestTipAddress: ValueHolderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ValueHolderTypeDef
  2. See ResponseMetadataTypeDef

GetRevisionRequestRequestTypeDef#

# GetRevisionRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import GetRevisionRequestRequestTypeDef

def get_value() -> GetRevisionRequestRequestTypeDef:
    return {
        "Name": ...,
        "BlockAddress": ...,
        "DocumentId": ...,
    }
# GetRevisionRequestRequestTypeDef definition

class GetRevisionRequestRequestTypeDef(TypedDict):
    Name: str,
    BlockAddress: ValueHolderTypeDef,  # (1)
    DocumentId: str,
    DigestTipAddress: NotRequired[ValueHolderTypeDef],  # (1)
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef

GetRevisionResponseTypeDef#

# GetRevisionResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import GetRevisionResponseTypeDef

def get_value() -> GetRevisionResponseTypeDef:
    return {
        "Proof": ...,
        "Revision": ...,
        "ResponseMetadata": ...,
    }
# GetRevisionResponseTypeDef definition

class GetRevisionResponseTypeDef(TypedDict):
    Proof: ValueHolderTypeDef,  # (1)
    Revision: ValueHolderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ValueHolderTypeDef
  2. See ValueHolderTypeDef
  3. See ResponseMetadataTypeDef

JournalKinesisStreamDescriptionTypeDef#

# JournalKinesisStreamDescriptionTypeDef usage example

from mypy_boto3_qldb.type_defs import JournalKinesisStreamDescriptionTypeDef

def get_value() -> JournalKinesisStreamDescriptionTypeDef:
    return {
        "LedgerName": ...,
        "RoleArn": ...,
        "StreamId": ...,
        "Status": ...,
        "KinesisConfiguration": ...,
        "StreamName": ...,
    }
# JournalKinesisStreamDescriptionTypeDef definition

class JournalKinesisStreamDescriptionTypeDef(TypedDict):
    LedgerName: str,
    RoleArn: str,
    StreamId: str,
    Status: StreamStatusType,  # (1)
    KinesisConfiguration: KinesisConfigurationTypeDef,  # (2)
    StreamName: str,
    CreationTime: NotRequired[datetime],
    InclusiveStartTime: NotRequired[datetime],
    ExclusiveEndTime: NotRequired[datetime],
    Arn: NotRequired[str],
    ErrorCause: NotRequired[ErrorCauseType],  # (3)
  1. See StreamStatusType
  2. See KinesisConfigurationTypeDef
  3. See ErrorCauseType

StreamJournalToKinesisRequestRequestTypeDef#

# StreamJournalToKinesisRequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import StreamJournalToKinesisRequestRequestTypeDef

def get_value() -> StreamJournalToKinesisRequestRequestTypeDef:
    return {
        "LedgerName": ...,
        "RoleArn": ...,
        "InclusiveStartTime": ...,
        "KinesisConfiguration": ...,
        "StreamName": ...,
    }
# StreamJournalToKinesisRequestRequestTypeDef definition

class StreamJournalToKinesisRequestRequestTypeDef(TypedDict):
    LedgerName: str,
    RoleArn: str,
    InclusiveStartTime: Union[datetime, str],
    KinesisConfiguration: KinesisConfigurationTypeDef,  # (1)
    StreamName: str,
    Tags: NotRequired[Mapping[str, str]],
    ExclusiveEndTime: NotRequired[Union[datetime, str]],
  1. See KinesisConfigurationTypeDef

ListLedgersResponseTypeDef#

# ListLedgersResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ListLedgersResponseTypeDef

def get_value() -> ListLedgersResponseTypeDef:
    return {
        "Ledgers": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListLedgersResponseTypeDef definition

class ListLedgersResponseTypeDef(TypedDict):
    Ledgers: List[LedgerSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LedgerSummaryTypeDef
  2. See ResponseMetadataTypeDef

S3ExportConfigurationTypeDef#

# S3ExportConfigurationTypeDef usage example

from mypy_boto3_qldb.type_defs import S3ExportConfigurationTypeDef

def get_value() -> S3ExportConfigurationTypeDef:
    return {
        "Bucket": ...,
        "Prefix": ...,
        "EncryptionConfiguration": ...,
    }
# S3ExportConfigurationTypeDef definition

class S3ExportConfigurationTypeDef(TypedDict):
    Bucket: str,
    Prefix: str,
    EncryptionConfiguration: S3EncryptionConfigurationTypeDef,  # (1)
  1. See S3EncryptionConfigurationTypeDef

DescribeJournalKinesisStreamResponseTypeDef#

# DescribeJournalKinesisStreamResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeJournalKinesisStreamResponseTypeDef

def get_value() -> DescribeJournalKinesisStreamResponseTypeDef:
    return {
        "Stream": ...,
        "ResponseMetadata": ...,
    }
# DescribeJournalKinesisStreamResponseTypeDef definition

class DescribeJournalKinesisStreamResponseTypeDef(TypedDict):
    Stream: JournalKinesisStreamDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JournalKinesisStreamDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListJournalKinesisStreamsForLedgerResponseTypeDef#

# ListJournalKinesisStreamsForLedgerResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalKinesisStreamsForLedgerResponseTypeDef

def get_value() -> ListJournalKinesisStreamsForLedgerResponseTypeDef:
    return {
        "Streams": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListJournalKinesisStreamsForLedgerResponseTypeDef definition

class ListJournalKinesisStreamsForLedgerResponseTypeDef(TypedDict):
    Streams: List[JournalKinesisStreamDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JournalKinesisStreamDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ExportJournalToS3RequestRequestTypeDef#

# ExportJournalToS3RequestRequestTypeDef usage example

from mypy_boto3_qldb.type_defs import ExportJournalToS3RequestRequestTypeDef

def get_value() -> ExportJournalToS3RequestRequestTypeDef:
    return {
        "Name": ...,
        "InclusiveStartTime": ...,
        "ExclusiveEndTime": ...,
        "S3ExportConfiguration": ...,
        "RoleArn": ...,
    }
# ExportJournalToS3RequestRequestTypeDef definition

class ExportJournalToS3RequestRequestTypeDef(TypedDict):
    Name: str,
    InclusiveStartTime: Union[datetime, str],
    ExclusiveEndTime: Union[datetime, str],
    S3ExportConfiguration: S3ExportConfigurationTypeDef,  # (1)
    RoleArn: str,
    OutputFormat: NotRequired[OutputFormatType],  # (2)
  1. See S3ExportConfigurationTypeDef
  2. See OutputFormatType

JournalS3ExportDescriptionTypeDef#

# JournalS3ExportDescriptionTypeDef usage example

from mypy_boto3_qldb.type_defs import JournalS3ExportDescriptionTypeDef

def get_value() -> JournalS3ExportDescriptionTypeDef:
    return {
        "LedgerName": ...,
        "ExportId": ...,
        "ExportCreationTime": ...,
        "Status": ...,
        "InclusiveStartTime": ...,
        "ExclusiveEndTime": ...,
        "S3ExportConfiguration": ...,
        "RoleArn": ...,
    }
# JournalS3ExportDescriptionTypeDef definition

class JournalS3ExportDescriptionTypeDef(TypedDict):
    LedgerName: str,
    ExportId: str,
    ExportCreationTime: datetime,
    Status: ExportStatusType,  # (1)
    InclusiveStartTime: datetime,
    ExclusiveEndTime: datetime,
    S3ExportConfiguration: S3ExportConfigurationTypeDef,  # (2)
    RoleArn: str,
    OutputFormat: NotRequired[OutputFormatType],  # (3)
  1. See ExportStatusType
  2. See S3ExportConfigurationTypeDef
  3. See OutputFormatType

DescribeJournalS3ExportResponseTypeDef#

# DescribeJournalS3ExportResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import DescribeJournalS3ExportResponseTypeDef

def get_value() -> DescribeJournalS3ExportResponseTypeDef:
    return {
        "ExportDescription": ...,
        "ResponseMetadata": ...,
    }
# DescribeJournalS3ExportResponseTypeDef definition

class DescribeJournalS3ExportResponseTypeDef(TypedDict):
    ExportDescription: JournalS3ExportDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JournalS3ExportDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListJournalS3ExportsForLedgerResponseTypeDef#

# ListJournalS3ExportsForLedgerResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalS3ExportsForLedgerResponseTypeDef

def get_value() -> ListJournalS3ExportsForLedgerResponseTypeDef:
    return {
        "JournalS3Exports": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListJournalS3ExportsForLedgerResponseTypeDef definition

class ListJournalS3ExportsForLedgerResponseTypeDef(TypedDict):
    JournalS3Exports: List[JournalS3ExportDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JournalS3ExportDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListJournalS3ExportsResponseTypeDef#

# ListJournalS3ExportsResponseTypeDef usage example

from mypy_boto3_qldb.type_defs import ListJournalS3ExportsResponseTypeDef

def get_value() -> ListJournalS3ExportsResponseTypeDef:
    return {
        "JournalS3Exports": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListJournalS3ExportsResponseTypeDef definition

class ListJournalS3ExportsResponseTypeDef(TypedDict):
    JournalS3Exports: List[JournalS3ExportDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JournalS3ExportDescriptionTypeDef
  2. See ResponseMetadataTypeDef