Skip to content

Type definitions#

Index > QLDB > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

CancelJournalKinesisStreamRequestRequestTypeDef#

# CancelJournalKinesisStreamRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateLedgerRequestRequestTypeDef#

# CreateLedgerRequestRequestTypeDef definition

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

DeleteLedgerRequestRequestTypeDef#

# DeleteLedgerRequestRequestTypeDef definition

class DeleteLedgerRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeJournalKinesisStreamRequestRequestTypeDef#

# DescribeJournalKinesisStreamRequestRequestTypeDef definition

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

DescribeJournalS3ExportRequestRequestTypeDef#

# DescribeJournalS3ExportRequestRequestTypeDef definition

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

DescribeLedgerRequestRequestTypeDef#

# DescribeLedgerRequestRequestTypeDef definition

class DescribeLedgerRequestRequestTypeDef(TypedDict):
    Name: str,

LedgerEncryptionDescriptionTypeDef#

# LedgerEncryptionDescriptionTypeDef definition

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

ValueHolderTypeDef#

# ValueHolderTypeDef definition

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

GetDigestRequestRequestTypeDef#

# GetDigestRequestRequestTypeDef definition

class GetDigestRequestRequestTypeDef(TypedDict):
    Name: str,

KinesisConfigurationTypeDef#

# KinesisConfigurationTypeDef definition

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

LedgerSummaryTypeDef#

# LedgerSummaryTypeDef definition

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

ListJournalKinesisStreamsForLedgerRequestRequestTypeDef#

# ListJournalKinesisStreamsForLedgerRequestRequestTypeDef definition

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

ListJournalS3ExportsForLedgerRequestRequestTypeDef#

# ListJournalS3ExportsForLedgerRequestRequestTypeDef definition

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

ListJournalS3ExportsRequestRequestTypeDef#

# ListJournalS3ExportsRequestRequestTypeDef definition

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

ListLedgersRequestRequestTypeDef#

# ListLedgersRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

S3EncryptionConfigurationTypeDef#

# S3EncryptionConfigurationTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateLedgerPermissionsModeRequestRequestTypeDef#

# UpdateLedgerPermissionsModeRequestRequestTypeDef definition

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

UpdateLedgerRequestRequestTypeDef#

# UpdateLedgerRequestRequestTypeDef definition

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

CancelJournalKinesisStreamResponseTypeDef#

# CancelJournalKinesisStreamResponseTypeDef definition

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

CreateLedgerResponseTypeDef#

# 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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ExportJournalToS3ResponseTypeDef#

# ExportJournalToS3ResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StreamJournalToKinesisResponseTypeDef#

# StreamJournalToKinesisResponseTypeDef definition

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

UpdateLedgerPermissionsModeResponseTypeDef#

# UpdateLedgerPermissionsModeResponseTypeDef definition

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

DescribeLedgerResponseTypeDef#

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

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

GetBlockResponseTypeDef#

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

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

GetRevisionRequestRequestTypeDef#

# GetRevisionRequestRequestTypeDef definition

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

GetRevisionResponseTypeDef#

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

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

S3ExportConfigurationTypeDef#

# S3ExportConfigurationTypeDef definition

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

DescribeJournalKinesisStreamResponseTypeDef#

# DescribeJournalKinesisStreamResponseTypeDef definition

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

ListJournalKinesisStreamsForLedgerResponseTypeDef#

# ListJournalKinesisStreamsForLedgerResponseTypeDef definition

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

ExportJournalToS3RequestRequestTypeDef#

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

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

ListJournalS3ExportsForLedgerResponseTypeDef#

# ListJournalS3ExportsForLedgerResponseTypeDef definition

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

ListJournalS3ExportsResponseTypeDef#

# ListJournalS3ExportsResponseTypeDef definition

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