Skip to content

Qldb Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CancelJournalKinesisStreamRequest

LedgerName

  • Type:
  • Required: Yes

StreamId

  • Type:
  • Required: Yes

CancelJournalKinesisStreamResponse

StreamId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateLedgerRequest

Name

  • Type:
  • Required: Yes

PermissionsMode

  • Type: typing.Literal['ALLOW_ALL', 'STANDARD']
  • Required: Yes

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

DeletionProtection

  • Type: typing.Optional[bool]

KmsKey

  • Type: typing.Optional[str]

CreateLedgerResponse

Name

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

CreationDateTime

  • Type:
  • Required: Yes

PermissionsMode

  • Type: typing.Literal['ALLOW_ALL', 'STANDARD']
  • Required: Yes

DeletionProtection

  • Type:
  • Required: Yes

KmsKeyArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteLedgerRequest

Name

  • Type:
  • Required: Yes

DescribeJournalKinesisStreamRequest

LedgerName

  • Type:
  • Required: Yes

StreamId

  • Type:
  • Required: Yes

DescribeJournalKinesisStreamResponse

Stream

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeJournalS3ExportRequest

Name

  • Type:
  • Required: Yes

ExportId

  • Type:
  • Required: Yes

DescribeJournalS3ExportResponse

ExportDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeLedgerRequest

Name

  • Type:
  • Required: Yes

DescribeLedgerResponse

Name

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

CreationDateTime

  • Type:
  • Required: Yes

PermissionsMode

  • Type: typing.Literal['ALLOW_ALL', 'STANDARD']
  • Required: Yes

DeletionProtection

  • Type:
  • Required: Yes

EncryptionDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

ExportJournalToS3Request

Name

  • Type:
  • Required: Yes

InclusiveStartTime

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

ExclusiveEndTime

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

S3ExportConfiguration

  • Type:
  • Required: Yes

RoleArn

  • Type:
  • Required: Yes

OutputFormat

  • Type: typing.Optional[typing.Literal['ION_BINARY', 'ION_TEXT', 'JSON']]

ExportJournalToS3Response

ExportId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBlockRequest

Name

  • Type:
  • Required: Yes

BlockAddress

  • Type:
  • Required: Yes

DigestTipAddress

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qldb.qldb_classes.ValueHolder]

GetBlockResponse

Block

  • Type:
  • Required: Yes

Proof

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDigestRequest

Name

  • Type:
  • Required: Yes

GetDigestResponse

Digest

  • Type:
  • Required: Yes

DigestTipAddress

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRevisionRequest

Name

  • Type:
  • Required: Yes

BlockAddress

  • Type:
  • Required: Yes

DocumentId

  • Type:
  • Required: Yes

DigestTipAddress

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qldb.qldb_classes.ValueHolder]

GetRevisionResponse

Proof

  • Type:
  • Required: Yes

Revision

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

JournalKinesisStreamDescription

LedgerName

  • Type:
  • Required: Yes

RoleArn

  • Type:
  • Required: Yes

StreamId

  • Type:
  • Required: Yes

Status

  • Type: typing.Literal['ACTIVE', 'CANCELED', 'COMPLETED', 'FAILED', 'IMPAIRED']
  • Required: Yes

KinesisConfiguration

  • Type:
  • Required: Yes

StreamName

  • Type:
  • Required: Yes

CreationTime

  • Type: typing.Optional[datetime.datetime]

InclusiveStartTime

  • Type: typing.Optional[datetime.datetime]

ExclusiveEndTime

  • Type: typing.Optional[datetime.datetime]

Arn

  • Type: typing.Optional[str]

ErrorCause

  • Type: typing.Optional[typing.Literal['IAM_PERMISSION_REVOKED', 'KINESIS_STREAM_NOT_FOUND']]

JournalS3ExportDescription

LedgerName

  • Type:
  • Required: Yes

ExportId

  • Type:
  • Required: Yes

ExportCreationTime

  • Type:
  • Required: Yes

Status

  • Type: typing.Literal['CANCELLED', 'COMPLETED', 'IN_PROGRESS']
  • Required: Yes

InclusiveStartTime

  • Type:
  • Required: Yes

ExclusiveEndTime

  • Type:
  • Required: Yes

S3ExportConfiguration

  • Type:
  • Required: Yes

RoleArn

  • Type:
  • Required: Yes

OutputFormat

  • Type: typing.Optional[typing.Literal['ION_BINARY', 'ION_TEXT', 'JSON']]

KinesisConfiguration

StreamArn

  • Type:
  • Required: Yes

AggregationEnabled

  • Type: typing.Optional[bool]

LedgerEncryptionDescription

KmsKeyArn

  • Type:
  • Required: Yes

EncryptionStatus

  • Type: typing.Literal['ENABLED', 'KMS_KEY_INACCESSIBLE', 'UPDATING']
  • Required: Yes

InaccessibleKmsKeyDateTime

  • Type: typing.Optional[datetime.datetime]

LedgerSummary

Name

  • Type: typing.Optional[str]

State

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETED', 'DELETING']]

CreationDateTime

  • Type: typing.Optional[datetime.datetime]

ListJournalKinesisStreamsForLedgerRequest

LedgerName

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListJournalKinesisStreamsForLedgerResponse

Streams

  • Type: typing.List[aws_resource_validator.pydantic_models.qldb.qldb_classes.JournalKinesisStreamDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListJournalS3ExportsForLedgerRequest

Name

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListJournalS3ExportsForLedgerResponse

JournalS3Exports

  • Type: typing.List[aws_resource_validator.pydantic_models.qldb.qldb_classes.JournalS3ExportDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListJournalS3ExportsRequest

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListJournalS3ExportsResponse

JournalS3Exports

  • Type: typing.List[aws_resource_validator.pydantic_models.qldb.qldb_classes.JournalS3ExportDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListLedgersRequest

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListLedgersResponse

Ledgers

  • Type: typing.List[aws_resource_validator.pydantic_models.qldb.qldb_classes.LedgerSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3EncryptionConfiguration

ObjectEncryptionType

  • Type: typing.Literal['NO_ENCRYPTION', 'SSE_KMS', 'SSE_S3']
  • Required: Yes

KmsKeyArn

  • Type: typing.Optional[str]

S3ExportConfiguration

Bucket

  • Type:
  • Required: Yes

Prefix

  • Type:
  • Required: Yes

EncryptionConfiguration

  • Type:
  • Required: Yes

StreamJournalToKinesisRequest

LedgerName

  • Type:
  • Required: Yes

RoleArn

  • Type:
  • Required: Yes

InclusiveStartTime

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

KinesisConfiguration

  • Type:
  • Required: Yes

StreamName

  • Type:
  • Required: Yes

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

ExclusiveEndTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

StreamJournalToKinesisResponse

StreamId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateLedgerPermissionsModeRequest

Name

  • Type:
  • Required: Yes

PermissionsMode

  • Type: typing.Literal['ALLOW_ALL', 'STANDARD']
  • Required: Yes

UpdateLedgerPermissionsModeResponse

Name

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

PermissionsMode

  • Type: typing.Literal['ALLOW_ALL', 'STANDARD']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateLedgerRequest

Name

  • Type:
  • Required: Yes

DeletionProtection

  • Type: typing.Optional[bool]

KmsKey

  • Type: typing.Optional[str]

UpdateLedgerResponse

Name

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

CreationDateTime

  • Type:
  • Required: Yes

DeletionProtection

  • Type:
  • Required: Yes

EncryptionDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValueHolder

IonText

  • Type: typing.Optional[str]