Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.

describeJournalS3Export

inline suspend fun QldbClient.describeJournalS3Export(crossinline block: DescribeJournalS3ExportRequest.Builder.() -> Unit): DescribeJournalS3ExportResponse

Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

describeLedger

inline suspend fun QldbClient.describeLedger(crossinline block: DescribeLedgerRequest.Builder.() -> Unit): DescribeLedgerResponse

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

exportJournalToS3

inline suspend fun QldbClient.exportJournalToS3(crossinline block: ExportJournalToS3Request.Builder.() -> Unit): ExportJournalToS3Response

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

getBlock

inline suspend fun QldbClient.getBlock(crossinline block: GetBlockRequest.Builder.() -> Unit): GetBlockResponse

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

getDigest

inline suspend fun QldbClient.getDigest(crossinline block: GetDigestRequest.Builder.() -> Unit): GetDigestResponse

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

getRevision

inline suspend fun QldbClient.getRevision(crossinline block: GetRevisionRequest.Builder.() -> Unit): GetRevisionResponse

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

listJournalKinesisStreamsForLedger

inline suspend fun QldbClient.listJournalKinesisStreamsForLedger(crossinline block: ListJournalKinesisStreamsForLedgerRequest.Builder.() -> Unit): ListJournalKinesisStreamsForLedgerResponse

Returns all Amazon QLDB journal streams for a given ledger.

listJournalS3Exports

inline suspend fun QldbClient.listJournalS3Exports(crossinline block: ListJournalS3ExportsRequest.Builder.() -> Unit): ListJournalS3ExportsResponse

Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.

listJournalS3ExportsForLedger

inline suspend fun QldbClient.listJournalS3ExportsForLedger(crossinline block: ListJournalS3ExportsForLedgerRequest.Builder.() -> Unit): ListJournalS3ExportsForLedgerResponse

Returns all journal export jobs for a specified ledger.

listLedgers

inline suspend fun QldbClient.listLedgers(crossinline block: ListLedgersRequest.Builder.() -> Unit): ListLedgersResponse

Returns all ledgers that are associated with the current Amazon Web Services account and Region.

listTagsForResource

inline suspend fun QldbClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns all tags for a specified Amazon QLDB resource.

streamJournalToKinesis

inline suspend fun QldbClient.streamJournalToKinesis(crossinline block: StreamJournalToKinesisRequest.Builder.() -> Unit): StreamJournalToKinesisResponse

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

tagResource

inline suspend fun QldbClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tags to a specified Amazon QLDB resource.

untagResource

inline suspend fun QldbClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

updateLedger

inline suspend fun QldbClient.updateLedger(crossinline block: UpdateLedgerRequest.Builder.() -> Unit): UpdateLedgerResponse

Updates properties on a ledger.

updateLedgerPermissionsMode

inline suspend fun QldbClient.updateLedgerPermissionsMode(crossinline block: UpdateLedgerPermissionsModeRequest.Builder.() -> Unit): UpdateLedgerPermissionsModeResponse

Updates the permissions mode of a ledger.

withConfig

fun QldbClient.withConfig(block: QldbClient.Config.Builder.() -> Unit): QldbClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.