View Source aws_qldb (aws v1.0.4)
Summary
Functions
Ends a given Amazon QLDB journal stream.
Deletes a ledger and all of its contents.
Returns detailed information about a given Amazon QLDB journal stream.
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.
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
Returns a block object at a specified address in a journal.
Returns the digest of a ledger at the latest committed block in the journal.
Returns a revision data object for a specified document ID and block address.
Returns all Amazon QLDB journal streams for a given ledger.
Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
Returns all journal export jobs for a specified ledger.
Returns all ledgers that are associated with the current Amazon Web Services account and Region.
Creates a journal stream for a given Amazon QLDB ledger.
Adds one or more tags to a specified Amazon QLDB resource.
Removes one or more tags from a specified Amazon QLDB resource.
Updates the permissions mode of a ledger.
Functions
cancel_journal_kinesis_stream(Client, LedgerName, StreamId, Input)
View SourceEnds a given Amazon QLDB journal stream.
Before a stream can be canceled, its current status must be ACTIVE
.
cancel_journal_kinesis_stream(Client, LedgerName, StreamId, Input0, Options0)
View SourceDeletes a ledger and all of its contents.
This action is irreversible.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling theUpdateLedger
operation to set this parameter to false
.
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.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration in the Amazon QLDB Developer Guide.describe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap)
View Sourcedescribe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap, Options0)
View SourceReturns 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.
This action does not return any expired export jobs. For more information, see Export job expiration: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration in the Amazon QLDB Developer Guide.
If the export job with the given ExportId
doesn't exist, then throws ResourceNotFoundException
.
Name
doesn't exist, then throws ResourceNotFoundException
.
describe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap)
View Sourcedescribe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap, Options0)
View SourceExports 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.
If the ledger with the given Name
doesn't exist, then throws ResourceNotFoundException
.
If the ledger with the given Name
is in CREATING
status, then throws ResourcePreconditionNotMetException
.
LimitExceededException
.
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.
For information about the data contents in a block, see Journal contents: https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in DELETING
status, then throws ResourceNotFoundException
.
If the specified ledger is in CREATING
status, then throws ResourcePreconditionNotMetException
.
InvalidParameterException
.
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.Returns a revision data object for a specified document ID and block address.
Also returns a proof of the specified revision for verification ifDigestTipAddress
is provided.
Returns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration in the Amazon QLDB Developer Guide.
This action returns a maximum ofMaxResults
items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger
multiple times.
list_journal_kinesis_streams_for_ledger(Client, LedgerName, QueryMap, HeadersMap)
View Sourcelist_journal_kinesis_streams_for_ledger(Client, LedgerName, QueryMap, HeadersMap, Options0)
View SourceReturns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults
items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports
multiple times.
Returns all journal export jobs for a specified ledger.
This action returns a maximum of MaxResults
items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger
multiple times.
list_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap)
View Sourcelist_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap, Options0)
View SourceReturns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum ofMaxResults
items and is paginated so that you can retrieve all the items by calling ListLedgers
multiple times.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceCreates 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.Adds one or more tags to a specified Amazon QLDB resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.Removes one or more tags from a specified Amazon QLDB resource.
You can specify up to 50 tag keys to remove.Updates the permissions mode of a ledger.
Before you switch to theSTANDARD
permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode: https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating in the Amazon QLDB Developer Guide.