QLDB class
The control plane for Amazon QLDB
Constructors
- QLDB({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelJournalKinesisStream(
{required String ledgerName, required String streamId}) → Future< CancelJournalKinesisStreamResponse> -
Ends a given Amazon QLDB journal stream. Before a stream can be canceled,
its current status must be
ACTIVE. -
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createLedger(
{required String name, required PermissionsMode permissionsMode, bool? deletionProtection, Map< String, String> ? tags}) → Future<CreateLedgerResponse> - Creates a new ledger in your AWS account.
-
deleteLedger(
{required String name}) → Future< void> - Deletes a ledger and all of its contents. This action is irreversible.
-
describeJournalKinesisStream(
{required String ledgerName, required String streamId}) → Future< DescribeJournalKinesisStreamResponse> - 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 your original stream creation request.
-
describeJournalS3Export(
{required String exportId, required String name}) → Future< DescribeJournalS3ExportResponse> - Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
-
describeLedger(
{required String name}) → Future< DescribeLedgerResponse> - Returns information about a ledger, including its state and when it was created.
-
exportJournalToS3(
{required DateTime exclusiveEndTime, required DateTime inclusiveStartTime, required String name, required String roleArn, required S3ExportConfiguration s3ExportConfiguration}) → Future< ExportJournalToS3Response> - Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.
-
getBlock(
{required ValueHolder blockAddress, required String name, ValueHolder? digestTipAddress}) → Future< GetBlockResponse> -
Returns a block object at a specified address in a journal. Also returns a
proof of the specified block for verification if
DigestTipAddressis provided. -
getDigest(
{required String name}) → Future< 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(
{required ValueHolder blockAddress, required String documentId, required String name, ValueHolder? digestTipAddress}) → Future< 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
DigestTipAddressis provided. -
listJournalKinesisStreamsForLedger(
{required String ledgerName, int? maxResults, String? nextToken}) → Future< ListJournalKinesisStreamsForLedgerResponse> -
Returns an array of all Amazon QLDB journal stream descriptors for a given
ledger. The output of each stream descriptor includes the same details
that are returned by
DescribeJournalKinesisStream. -
listJournalS3Exports(
{int? maxResults, String? nextToken}) → Future< ListJournalS3ExportsResponse> - Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
-
listJournalS3ExportsForLedger(
{required String name, int? maxResults, String? nextToken}) → Future< ListJournalS3ExportsForLedgerResponse> - Returns an array of journal export job descriptions for a specified ledger.
-
listLedgers(
{int? maxResults, String? nextToken}) → Future< ListLedgersResponse> - Returns an array of ledger summaries that are associated with the current AWS account and Region.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Returns all tags for a specified Amazon QLDB resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
streamJournalToKinesis(
{required DateTime inclusiveStartTime, required KinesisConfiguration kinesisConfiguration, required String ledgerName, required String roleArn, required String streamName, DateTime? exclusiveEndTime, Map< String, String> ? tags}) → Future<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(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Adds one or more tags to a specified Amazon QLDB resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
-
updateLedger(
{required String name, bool? deletionProtection}) → Future< UpdateLedgerResponse> - Updates properties on a ledger.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited