Typed dictionaries
Auto-generated documentation for QLDB type annotations stubs module mypy-boto3-qldb.
CancelJournalKinesisStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import CancelJournalKinesisStreamRequestRequestTypeDef
def get_value() -> CancelJournalKinesisStreamRequestRequestTypeDef:
return {
"LedgerName": ...,
"StreamId": ...,
}
Definition
class CancelJournalKinesisStreamRequestRequestTypeDef(TypedDict):
LedgerName: str,
StreamId: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import CreateLedgerRequestRequestTypeDef
def get_value() -> CreateLedgerRequestRequestTypeDef:
return {
"Name": ...,
"PermissionsMode": ...,
}
Definition
class CreateLedgerRequestRequestTypeDef(TypedDict):
Name: str,
PermissionsMode: PermissionsModeType, # (1)
Tags: NotRequired[Mapping[str, str]],
DeletionProtection: NotRequired[bool],
KmsKey: NotRequired[str],
DeleteLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DeleteLedgerRequestRequestTypeDef
def get_value() -> DeleteLedgerRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeJournalKinesisStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeJournalKinesisStreamRequestRequestTypeDef
def get_value() -> DescribeJournalKinesisStreamRequestRequestTypeDef:
return {
"LedgerName": ...,
"StreamId": ...,
}
Definition
class DescribeJournalKinesisStreamRequestRequestTypeDef(TypedDict):
LedgerName: str,
StreamId: str,
DescribeJournalS3ExportRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeJournalS3ExportRequestRequestTypeDef
def get_value() -> DescribeJournalS3ExportRequestRequestTypeDef:
return {
"Name": ...,
"ExportId": ...,
}
DescribeLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeLedgerRequestRequestTypeDef
def get_value() -> DescribeLedgerRequestRequestTypeDef:
return {
"Name": ...,
}
LedgerEncryptionDescriptionTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import LedgerEncryptionDescriptionTypeDef
def get_value() -> LedgerEncryptionDescriptionTypeDef:
return {
"KmsKeyArn": ...,
"EncryptionStatus": ...,
}
Definition
class LedgerEncryptionDescriptionTypeDef(TypedDict):
KmsKeyArn: str,
EncryptionStatus: EncryptionStatusType, # (1)
InaccessibleKmsKeyDateTime: NotRequired[datetime],
ValueHolderTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ValueHolderTypeDef
def get_value() -> ValueHolderTypeDef:
return {
"IonText": ...,
}
GetDigestRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetDigestRequestRequestTypeDef
def get_value() -> GetDigestRequestRequestTypeDef:
return {
"Name": ...,
}
KinesisConfigurationTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import KinesisConfigurationTypeDef
def get_value() -> KinesisConfigurationTypeDef:
return {
"StreamArn": ...,
}
Definition
class KinesisConfigurationTypeDef(TypedDict):
StreamArn: str,
AggregationEnabled: NotRequired[bool],
LedgerSummaryTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import LedgerSummaryTypeDef
def get_value() -> LedgerSummaryTypeDef:
return {
"Name": ...,
}
Definition
class LedgerSummaryTypeDef(TypedDict):
Name: NotRequired[str],
State: NotRequired[LedgerStateType], # (1)
CreationDateTime: NotRequired[datetime],
- See LedgerStateType
ListJournalKinesisStreamsForLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalKinesisStreamsForLedgerRequestRequestTypeDef
def get_value() -> ListJournalKinesisStreamsForLedgerRequestRequestTypeDef:
return {
"LedgerName": ...,
}
Definition
class ListJournalKinesisStreamsForLedgerRequestRequestTypeDef(TypedDict):
LedgerName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListJournalS3ExportsForLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalS3ExportsForLedgerRequestRequestTypeDef
def get_value() -> ListJournalS3ExportsForLedgerRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class ListJournalS3ExportsForLedgerRequestRequestTypeDef(TypedDict):
Name: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListJournalS3ExportsRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalS3ExportsRequestRequestTypeDef
def get_value() -> ListJournalS3ExportsRequestRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListJournalS3ExportsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListLedgersRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListLedgersRequestRequestTypeDef
def get_value() -> ListLedgersRequestRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListLedgersRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
S3EncryptionConfigurationTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import S3EncryptionConfigurationTypeDef
def get_value() -> S3EncryptionConfigurationTypeDef:
return {
"ObjectEncryptionType": ...,
}
Definition
class S3EncryptionConfigurationTypeDef(TypedDict):
ObjectEncryptionType: S3ObjectEncryptionTypeType, # (1)
KmsKeyArn: NotRequired[str],
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateLedgerPermissionsModeRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import UpdateLedgerPermissionsModeRequestRequestTypeDef
def get_value() -> UpdateLedgerPermissionsModeRequestRequestTypeDef:
return {
"Name": ...,
"PermissionsMode": ...,
}
Definition
class UpdateLedgerPermissionsModeRequestRequestTypeDef(TypedDict):
Name: str,
PermissionsMode: PermissionsModeType, # (1)
UpdateLedgerRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import UpdateLedgerRequestRequestTypeDef
def get_value() -> UpdateLedgerRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class UpdateLedgerRequestRequestTypeDef(TypedDict):
Name: str,
DeletionProtection: NotRequired[bool],
KmsKey: NotRequired[str],
CancelJournalKinesisStreamResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import CancelJournalKinesisStreamResponseTypeDef
def get_value() -> CancelJournalKinesisStreamResponseTypeDef:
return {
"StreamId": ...,
"ResponseMetadata": ...,
}
Definition
class CancelJournalKinesisStreamResponseTypeDef(TypedDict):
StreamId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateLedgerResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import CreateLedgerResponseTypeDef
def get_value() -> CreateLedgerResponseTypeDef:
return {
"Name": ...,
"Arn": ...,
"State": ...,
"CreationDateTime": ...,
"PermissionsMode": ...,
"DeletionProtection": ...,
"KmsKeyArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateLedgerResponseTypeDef(TypedDict):
Name: str,
Arn: str,
State: LedgerStateType, # (1)
CreationDateTime: datetime,
PermissionsMode: PermissionsModeType, # (2)
DeletionProtection: bool,
KmsKeyArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportJournalToS3ResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ExportJournalToS3ResponseTypeDef
def get_value() -> ExportJournalToS3ResponseTypeDef:
return {
"ExportId": ...,
"ResponseMetadata": ...,
}
Definition
class ExportJournalToS3ResponseTypeDef(TypedDict):
ExportId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StreamJournalToKinesisResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import StreamJournalToKinesisResponseTypeDef
def get_value() -> StreamJournalToKinesisResponseTypeDef:
return {
"StreamId": ...,
"ResponseMetadata": ...,
}
Definition
class StreamJournalToKinesisResponseTypeDef(TypedDict):
StreamId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateLedgerPermissionsModeResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import UpdateLedgerPermissionsModeResponseTypeDef
def get_value() -> UpdateLedgerPermissionsModeResponseTypeDef:
return {
"Name": ...,
"Arn": ...,
"PermissionsMode": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateLedgerPermissionsModeResponseTypeDef(TypedDict):
Name: str,
Arn: str,
PermissionsMode: PermissionsModeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeLedgerResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeLedgerResponseTypeDef
def get_value() -> DescribeLedgerResponseTypeDef:
return {
"Name": ...,
"Arn": ...,
"State": ...,
"CreationDateTime": ...,
"PermissionsMode": ...,
"DeletionProtection": ...,
"EncryptionDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeLedgerResponseTypeDef(TypedDict):
Name: str,
Arn: str,
State: LedgerStateType, # (1)
CreationDateTime: datetime,
PermissionsMode: PermissionsModeType, # (2)
DeletionProtection: bool,
EncryptionDescription: LedgerEncryptionDescriptionTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See LedgerStateType
- See PermissionsModeType
- See LedgerEncryptionDescriptionTypeDef
- See ResponseMetadataTypeDef
UpdateLedgerResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import UpdateLedgerResponseTypeDef
def get_value() -> UpdateLedgerResponseTypeDef:
return {
"Name": ...,
"Arn": ...,
"State": ...,
"CreationDateTime": ...,
"DeletionProtection": ...,
"EncryptionDescription": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateLedgerResponseTypeDef(TypedDict):
Name: str,
Arn: str,
State: LedgerStateType, # (1)
CreationDateTime: datetime,
DeletionProtection: bool,
EncryptionDescription: LedgerEncryptionDescriptionTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetBlockRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetBlockRequestRequestTypeDef
def get_value() -> GetBlockRequestRequestTypeDef:
return {
"Name": ...,
"BlockAddress": ...,
}
Definition
class GetBlockRequestRequestTypeDef(TypedDict):
Name: str,
BlockAddress: ValueHolderTypeDef, # (1)
DigestTipAddress: NotRequired[ValueHolderTypeDef], # (1)
- See ValueHolderTypeDef
- See ValueHolderTypeDef
GetBlockResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetBlockResponseTypeDef
def get_value() -> GetBlockResponseTypeDef:
return {
"Block": ...,
"Proof": ...,
"ResponseMetadata": ...,
}
Definition
class GetBlockResponseTypeDef(TypedDict):
Block: ValueHolderTypeDef, # (1)
Proof: ValueHolderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetDigestResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetDigestResponseTypeDef
def get_value() -> GetDigestResponseTypeDef:
return {
"Digest": ...,
"DigestTipAddress": ...,
"ResponseMetadata": ...,
}
Definition
class GetDigestResponseTypeDef(TypedDict):
Digest: bytes,
DigestTipAddress: ValueHolderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRevisionRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetRevisionRequestRequestTypeDef
def get_value() -> GetRevisionRequestRequestTypeDef:
return {
"Name": ...,
"BlockAddress": ...,
"DocumentId": ...,
}
Definition
class GetRevisionRequestRequestTypeDef(TypedDict):
Name: str,
BlockAddress: ValueHolderTypeDef, # (1)
DocumentId: str,
DigestTipAddress: NotRequired[ValueHolderTypeDef], # (1)
- See ValueHolderTypeDef
- See ValueHolderTypeDef
GetRevisionResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import GetRevisionResponseTypeDef
def get_value() -> GetRevisionResponseTypeDef:
return {
"Proof": ...,
"Revision": ...,
"ResponseMetadata": ...,
}
Definition
class GetRevisionResponseTypeDef(TypedDict):
Proof: ValueHolderTypeDef, # (1)
Revision: ValueHolderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
JournalKinesisStreamDescriptionTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import JournalKinesisStreamDescriptionTypeDef
def get_value() -> JournalKinesisStreamDescriptionTypeDef:
return {
"LedgerName": ...,
"RoleArn": ...,
"StreamId": ...,
"Status": ...,
"KinesisConfiguration": ...,
"StreamName": ...,
}
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)
StreamJournalToKinesisRequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import StreamJournalToKinesisRequestRequestTypeDef
def get_value() -> StreamJournalToKinesisRequestRequestTypeDef:
return {
"LedgerName": ...,
"RoleArn": ...,
"InclusiveStartTime": ...,
"KinesisConfiguration": ...,
"StreamName": ...,
}
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]],
ListLedgersResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListLedgersResponseTypeDef
def get_value() -> ListLedgersResponseTypeDef:
return {
"Ledgers": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListLedgersResponseTypeDef(TypedDict):
Ledgers: List[LedgerSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
S3ExportConfigurationTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import S3ExportConfigurationTypeDef
def get_value() -> S3ExportConfigurationTypeDef:
return {
"Bucket": ...,
"Prefix": ...,
"EncryptionConfiguration": ...,
}
Definition
class S3ExportConfigurationTypeDef(TypedDict):
Bucket: str,
Prefix: str,
EncryptionConfiguration: S3EncryptionConfigurationTypeDef, # (1)
DescribeJournalKinesisStreamResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeJournalKinesisStreamResponseTypeDef
def get_value() -> DescribeJournalKinesisStreamResponseTypeDef:
return {
"Stream": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJournalKinesisStreamResponseTypeDef(TypedDict):
Stream: JournalKinesisStreamDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJournalKinesisStreamsForLedgerResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalKinesisStreamsForLedgerResponseTypeDef
def get_value() -> ListJournalKinesisStreamsForLedgerResponseTypeDef:
return {
"Streams": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJournalKinesisStreamsForLedgerResponseTypeDef(TypedDict):
Streams: List[JournalKinesisStreamDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ExportJournalToS3RequestRequestTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ExportJournalToS3RequestRequestTypeDef
def get_value() -> ExportJournalToS3RequestRequestTypeDef:
return {
"Name": ...,
"InclusiveStartTime": ...,
"ExclusiveEndTime": ...,
"S3ExportConfiguration": ...,
"RoleArn": ...,
}
Definition
class ExportJournalToS3RequestRequestTypeDef(TypedDict):
Name: str,
InclusiveStartTime: Union[datetime, str],
ExclusiveEndTime: Union[datetime, str],
S3ExportConfiguration: S3ExportConfigurationTypeDef, # (1)
RoleArn: str,
OutputFormat: NotRequired[OutputFormatType], # (2)
JournalS3ExportDescriptionTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import JournalS3ExportDescriptionTypeDef
def get_value() -> JournalS3ExportDescriptionTypeDef:
return {
"LedgerName": ...,
"ExportId": ...,
"ExportCreationTime": ...,
"Status": ...,
"InclusiveStartTime": ...,
"ExclusiveEndTime": ...,
"S3ExportConfiguration": ...,
"RoleArn": ...,
}
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)
DescribeJournalS3ExportResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import DescribeJournalS3ExportResponseTypeDef
def get_value() -> DescribeJournalS3ExportResponseTypeDef:
return {
"ExportDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJournalS3ExportResponseTypeDef(TypedDict):
ExportDescription: JournalS3ExportDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJournalS3ExportsForLedgerResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalS3ExportsForLedgerResponseTypeDef
def get_value() -> ListJournalS3ExportsForLedgerResponseTypeDef:
return {
"JournalS3Exports": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJournalS3ExportsForLedgerResponseTypeDef(TypedDict):
JournalS3Exports: List[JournalS3ExportDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJournalS3ExportsResponseTypeDef
Usage Example
from mypy_boto3_qldb.type_defs import ListJournalS3ExportsResponseTypeDef
def get_value() -> ListJournalS3ExportsResponseTypeDef:
return {
"JournalS3Exports": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}