aws_qldb
The control plane for Amazon QLDB
Summary
Functions
-
cancel_journal_kinesis_stream(Client, LedgerName, StreamId, Input)
Ends a given Amazon QLDB journal stream.
- cancel_journal_kinesis_stream(Client, LedgerName, StreamId, Input0, Options0)
-
create_ledger(Client, Input)
Creates a new ledger in your AWS account.
- create_ledger(Client, Input0, Options0)
-
delete_ledger(Client, Name, Input)
Deletes a ledger and all of its contents.
- delete_ledger(Client, Name, Input0, Options0)
-
describe_journal_kinesis_stream(Client, LedgerName, StreamId)
Returns detailed information about a given Amazon QLDB journal stream.
- describe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap)
- describe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap, Options0)
-
describe_journal_s3_export(Client, ExportId, Name)
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.
- describe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap)
- describe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap, Options0)
-
describe_ledger(Client, Name)
Returns information about a ledger, including its state and when it was created.
- describe_ledger(Client, Name, QueryMap, HeadersMap)
- describe_ledger(Client, Name, QueryMap, HeadersMap, Options0)
-
export_journal_to_s3(Client, Name, Input)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
- export_journal_to_s3(Client, Name, Input0, Options0)
-
get_block(Client, Name, Input)
Returns a block object at a specified address in a journal.
- get_block(Client, Name, Input0, Options0)
-
get_digest(Client, Name, Input)
Returns the digest of a ledger at the latest committed block in the journal.
- get_digest(Client, Name, Input0, Options0)
-
get_revision(Client, Name, Input)
Returns a revision data object for a specified document ID and block address.
- get_revision(Client, Name, Input0, Options0)
-
list_journal_kinesis_streams_for_ledger(Client, LedgerName)
Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
- list_journal_kinesis_streams_for_ledger(Client, LedgerName, QueryMap, HeadersMap)
- list_journal_kinesis_streams_for_ledger(Client, LedgerName, QueryMap, HeadersMap, Options0)
-
list_journal_s3_exports(Client)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
- list_journal_s3_exports(Client, QueryMap, HeadersMap)
- list_journal_s3_exports(Client, QueryMap, HeadersMap, Options0)
-
list_journal_s3_exports_for_ledger(Client, Name)
Returns an array of journal export job descriptions for a specified ledger.
- list_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap)
- list_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap, Options0)
-
list_ledgers(Client)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
- list_ledgers(Client, QueryMap, HeadersMap)
- list_ledgers(Client, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Returns all tags for a specified Amazon QLDB resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
stream_journal_to_kinesis(Client, LedgerName, Input)
Creates a journal stream for a given Amazon QLDB ledger.
- stream_journal_to_kinesis(Client, LedgerName, Input0, Options0)
-
tag_resource(Client, ResourceArn, Input)
Adds one or more tags to a specified Amazon QLDB resource.
- tag_resource(Client, ResourceArn, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Removes one or more tags from a specified Amazon QLDB resource.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_ledger(Client, Name, Input)
Updates properties on a ledger.
- update_ledger(Client, Name, Input0, Options0)
Functions
cancel_journal_kinesis_stream(Client, LedgerName, StreamId, Input)
Ends 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)
create_ledger(Client, Input)
Creates a new ledger in your AWS account.
create_ledger(Client, Input0, Options0)
delete_ledger(Client, Name, Input)
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 using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling theUpdateLedger
operation to
set the flag to false
. The QLDB console disables deletion protection for
you when you use it to delete a ledger.
delete_ledger(Client, Name, Input0, Options0)
describe_journal_kinesis_stream(Client, LedgerName, StreamId)
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.describe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap)
describe_journal_kinesis_stream(Client, LedgerName, StreamId, QueryMap, HeadersMap, Options0)
describe_journal_s3_export(Client, ExportId, Name)
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.
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
.
Name
doesn't exist, then throws
ResourceNotFoundException
.
describe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap)
describe_journal_s3_export(Client, ExportId, Name, QueryMap, HeadersMap, Options0)
describe_ledger(Client, Name)
Returns information about a ledger, including its state and when it was created.
describe_ledger(Client, Name, QueryMap, HeadersMap)
describe_ledger(Client, Name, QueryMap, HeadersMap, Options0)
export_journal_to_s3(Client, Name, Input)
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.
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
.
export_journal_to_s3(Client, Name, Input0, Options0)
get_block(Client, Name, Input)
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
.
InvalidParameterException
.
get_block(Client, Name, Input0, Options0)
get_digest(Client, Name, Input)
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.get_digest(Client, Name, Input0, Options0)
get_revision(Client, Name, Input)
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.
get_revision(Client, Name, Input0, Options0)
list_journal_kinesis_streams_for_ledger(Client, LedgerName)
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
.
MaxResults
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)
list_journal_kinesis_streams_for_ledger(Client, LedgerName, QueryMap, HeadersMap, Options0)
list_journal_s3_exports(Client)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS 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.
list_journal_s3_exports(Client, QueryMap, HeadersMap)
list_journal_s3_exports(Client, QueryMap, HeadersMap, Options0)
list_journal_s3_exports_for_ledger(Client, Name)
Returns 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.
list_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap)
list_journal_s3_exports_for_ledger(Client, Name, QueryMap, HeadersMap, Options0)
list_ledgers(Client)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by callingListLedgers
multiple times.
list_ledgers(Client, QueryMap, HeadersMap)
list_ledgers(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
Returns all tags for a specified Amazon QLDB resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
stream_journal_to_kinesis(Client, LedgerName, Input)
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.stream_journal_to_kinesis(Client, LedgerName, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
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.tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Removes one or more tags from a specified Amazon QLDB resource.
You can specify up to 50 tag keys to remove.untag_resource(Client, ResourceArn, Input0, Options0)
update_ledger(Client, Name, Input)
Updates properties on a ledger.