Amazon Web Services, Inc.

Amazon QLDB

The control plane for Amazon QLDB

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The control plane for Amazon QLDB

Endpoints 20

  • GETDescribeJournalKinesisStream/ledgers/:name/journal-kinesis-streams/:streamId<p>Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status,…
  • DELETECancelJournalKinesisStream/ledgers/:name/journal-kinesis-streams/:streamId<p>Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be <code>ACTIVE</code>.</p> <p>You can't restart a stream…
  • GETListLedgers/ledgers?max_results=1&next_token=string&MaxResults=string&NextToken=string<p>Returns an array of ledger summaries that are associated with the current Amazon Web Services account and Region.</p> <p>This action returns a maximum of…
  • POSTCreateLedger/ledgersCreates a new ledger in your Amazon Web Services account in the current Region.
  • GETDescribeLedger/ledgers/:nameReturns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
  • DELETEDeleteLedger/ledgers/:name<p>Deletes a ledger and all of its contents. This action is irreversible.</p> <p>If deletion protection is enabled, you must first disable it before you can…
  • PATCHUpdateLedger/ledgers/:nameUpdates properties on a ledger.
  • GETDescribeJournalS3Export/ledgers/:name/journal-s3-exports/:exportId<p>Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original…
  • GETListJournalS3ExportsForLedger/ledgers/:name/journal-s3-exports?max_results=1&next_token=string&MaxResults=string&NextToken=string<p>Returns an array of journal export job descriptions for a specified ledger.</p> <p>This action returns a maximum of <code>MaxResults</code> items, and is…
  • POSTExportJournalToS3/ledgers/:name/journal-s3-exports<p>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…
  • POSTGetBlock/ledgers/:name/block<p>Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if <code>DigestTipAddress</code>…
  • POSTGetDigest/ledgers/:name/digestReturns 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.
  • POSTGetRevision/ledgers/:name/revisionReturns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if…
  • GETListJournalKinesisStreamsForLedger/ledgers/:name/journal-kinesis-streams?max_results=1&next_token=string&MaxResults=string&NextToken=string<p>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…
  • POSTStreamJournalToKinesis/ledgers/:name/journal-kinesis-streamsCreates 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…
  • GETListJournalS3Exports/journal-s3-exports?max_results=1&next_token=string&MaxResults=string&NextToken=string<p>Returns an array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.</p>…
  • GETListTagsForResource/tags/:resourceArnReturns all tags for a specified Amazon QLDB resource.
  • POSTTagResource/tags/:resourceArn<p>Adds one or more tags to a specified Amazon QLDB resource.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource,…
  • DELETEUntagResource/tags/:resourceArn#tagKeys?tagKeys=stringRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
  • PATCHUpdateLedgerPermissionsMode/ledgers/:name/permissions-mode<p>Updates the permissions mode of a ledger.</p> <important> <p>Before you switch to the <code>STANDARD</code> permissions mode, you must first create all…

API details

Base URL
http://qldb.{region}.amazonaws.com
https://qldb.{region}.amazonaws.com
http://qldb.{region}.amazonaws.com.cn
https://qldb.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
20 operations on 13 pathsGET 8POST 7DELETE 3PATCH 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2019-01-02
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Amazon QLDB in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon QLDB collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “DescribeJournalKinesisStream” (GET /ledgers/:name/journal-kinesis-streams/:streamId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon QLDB?

The control plane for Amazon QLDB It is listed under Developer tools and has 20 endpoints.

Who publishes the Amazon QLDB?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon QLDB?

Its description lists 4 base URLs: http://qldb.{region}.amazonaws.com, https://qldb.{region}.amazonaws.com, http://qldb.{region}.amazonaws.com.cn, https://qldb.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Amazon QLDB?

With an API key in the Authorization header.

How many endpoints does the Amazon QLDB have?

20 operations on 13 paths (8 GET, 7 POST, 3 DELETE, 2 PATCH).

Is forking the Amazon QLDB free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.