Class: AWS.QLDB
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.QLDB
- Identifier:
- qldb
- API Version:
- 2019-01-02
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
The control plane for Amazon QLDB
Sending a Request Using QLDB
var qldb = new AWS.QLDB();
qldb.cancelJournalKinesisStream(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the QLDB object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var qldb = new AWS.QLDB({apiVersion: '2019-01-02'});
You can also set the API version globally in AWS.config.apiVersions
using
the qldb service identifier:
AWS.config.apiVersions = {
qldb: '2019-01-02',
// other service API versions
};
var qldb = new AWS.QLDB();
Constructor Summary collapse
-
new AWS.QLDB(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
cancelJournalKinesisStream(params = {}, callback) ⇒ AWS.Request
Ends a given Amazon QLDB journal stream.
-
createLedger(params = {}, callback) ⇒ AWS.Request
Creates a new ledger in your AWS account.
-
deleteLedger(params = {}, callback) ⇒ AWS.Request
Deletes a ledger and all of its contents.
-
describeJournalKinesisStream(params = {}, callback) ⇒ AWS.Request
Returns detailed information about a given Amazon QLDB journal stream.
-
describeJournalS3Export(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
Returns information about a ledger, including its state and when it was created.
-
exportJournalToS3(params = {}, callback) ⇒ AWS.Request
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
-
getBlock(params = {}, callback) ⇒ AWS.Request
Returns a block object at a specified address in a journal.
-
getDigest(params = {}, callback) ⇒ AWS.Request
Returns the digest of a ledger at the latest committed block in the journal.
-
getRevision(params = {}, callback) ⇒ AWS.Request
Returns a revision data object for a specified document ID and block address.
-
listJournalKinesisStreamsForLedger(params = {}, callback) ⇒ AWS.Request
Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
-
listJournalS3Exports(params = {}, callback) ⇒ AWS.Request
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
-
listJournalS3ExportsForLedger(params = {}, callback) ⇒ AWS.Request
Returns an array of journal export job descriptions for a specified ledger.
-
listLedgers(params = {}, callback) ⇒ AWS.Request
Returns an array of ledger summaries that are associated with the current AWS account and Region.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns all tags for a specified Amazon QLDB resource.
-
streamJournalToKinesis(params = {}, callback) ⇒ AWS.Request
Creates a journal stream for a given Amazon QLDB ledger.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to a specified Amazon QLDB resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from a specified Amazon QLDB resource.
-
updateLedger(params = {}, callback) ⇒ AWS.Request
Updates properties on a ledger.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.QLDB(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
cancelJournalKinesisStream(params = {}, callback) ⇒ AWS.Request
Ends 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.
deleteLedger(params = {}, callback) ⇒ AWS.Request
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 the UpdateLedger
operation to set the flag to false
. The QLDB console disables deletion protection for you when you use it to delete a ledger.
describeJournalKinesisStream(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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
.
If the ledger with the given Name
doesn't exist, then throws ResourceNotFoundException
.
describeLedger(params = {}, callback) ⇒ AWS.Request
Returns information about a ledger, including its state and when it was created.
exportJournalToS3(params = {}, callback) ⇒ AWS.Request
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
.
You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException
.
getBlock(params = {}, callback) ⇒ AWS.Request
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
.
getDigest(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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
.
This action returns a maximum of MaxResults
items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger
multiple times.
listJournalS3Exports(params = {}, callback) ⇒ AWS.Request
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.
This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
listJournalS3ExportsForLedger(params = {}, callback) ⇒ AWS.Request
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.
This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
listLedgers(params = {}, callback) ⇒ AWS.Request
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 calling ListLedgers
multiple times.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns all tags for a specified Amazon QLDB resource.
streamJournalToKinesis(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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.