View Source AWS.QLDB (aws-elixir v0.13.3)
The control plane for Amazon QLDB
Link to this section Summary
Functions
Ends a given Amazon QLDB journal stream.
Creates a new ledger in your Amazon Web Services account in the current Region.
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.
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
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 an array of all Amazon QLDB journal stream descriptors for a given ledger.
Returns an array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.
Returns an array of journal export job descriptions for a specified ledger.
Returns an array of ledger summaries that are associated with the current Amazon Web Services account and Region.
Returns all tags for a specified Amazon QLDB resource.
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 properties on a ledger.
Updates the permissions mode of a ledger.
Link to this section Functions
cancel_journal_kinesis_stream(client, ledger_name, stream_id, input, options \\ [])
View SourceEnds a given Amazon QLDB journal stream.
Before a stream can be canceled, its current status must be ACTIVE
.
You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
Creates a new ledger in your Amazon Web Services account in the current Region.
Deletes 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 the UpdateLedger
operation to
set the flag to false
.
describe_journal_kinesis_stream(client, ledger_name, stream_id, options \\ [])
View SourceReturns 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 in the Amazon QLDB Developer Guide.
describe_journal_s3_export(client, export_id, name, options \\ [])
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 in the Amazon QLDB Developer Guide.
If the export job with the given ExportId
doesn't exist, then throws
ResourceNotFoundException
.
If the ledger with the given Name
doesn't exist, then throws
ResourceNotFoundException
.
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
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.
In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines.
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
.
You can initiate up to two concurrent journal export requests for each ledger.
Beyond this limit, journal export requests throw 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 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
.
If no block exists with the specified address, then throws
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 if
DigestTipAddress
is provided.
list_journal_kinesis_streams_for_ledger(client, ledger_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns 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
.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults
items. It is paginated so that you
can retrieve all the items by calling ListJournalKinesisStreamsForLedger
multiple times.
list_journal_s3_exports(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns an array of journal export job descriptions 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.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
list_journal_s3_exports_for_ledger(client, name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns an array of journal export job descriptions 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.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
list_ledgers(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns an array of ledger summaries that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of 100 items and is paginated so that you can
retrieve all the items by calling ListLedgers
multiple times.
Returns all tags for a specified Amazon QLDB resource.
stream_journal_to_kinesis(client, ledger_name, input, options \\ [])
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 properties on a ledger.
update_ledger_permissions_mode(client, name, input, options \\ [])
View SourceUpdates the permissions mode of a ledger.
Before you switch to the STANDARD
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
in the Amazon QLDB Developer Guide.