How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Amazon QLDB

Amazon QLDB Ledgers API

The Ledgers API from Amazon QLDB — 10 operation(s) for ledgers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Amazon QLDB Ledgers API is one of 3 APIs that Amazon QLDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ledgers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 16 operations across 10 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 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.

16 operations 10 paths 53 schemas 2 DELETE6 GET2 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://qldb.amazonaws.com
Authentication
API Key
Contact
Mike Ralphson
License
Apache 2.0 License
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Amazon QLDB Ledgers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 6 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Ledgers 16
DELETE
/ledgers/{name}/journal-kinesis-streams/{streamId}
Amazon QLDB Cancel Journal Kinesis Stream
CancelJournalKinesisStream 9 params → 200480481482
GET
/ledgers/{name}/journal-kinesis-streams/{streamId}
Amazon QLDB Describe Journal Kinesis Stream
DescribeJournalKinesisStream 9 params → 200480481482
POST
/ledgers
Amazon QLDB Create Ledger
CreateLedger 7 params body → 200480481482483
GET
/ledgers
Amazon QLDB List Ledgers
ListLedgers 11 params → 200
DELETE
/ledgers/{name}
Amazon QLDB Delete Ledger
DeleteLedger 8 params → 200480481482483
GET
/ledgers/{name}
Amazon QLDB Describe Ledger
DescribeLedger 8 params → 200480481
PATCH
/ledgers/{name}
Amazon QLDB Update Ledger
UpdateLedger 8 params body → 200480481
GET
/ledgers/{name}/journal-s3-exports/{exportId}
Amazon QLDB Describe Journal S3 Export
DescribeJournalS3Export 9 params → 200480
POST
/ledgers/{name}/journal-s3-exports
Amazon QLDB Export Journal To S3
ExportJournalToS3 8 params body → 200480481
GET
/ledgers/{name}/journal-s3-exports
Amazon QLDB List Journal S3 Exports For Ledger
ListJournalS3ExportsForLedger 12 params → 200
POST
/ledgers/{name}/block
Amazon QLDB Get Block
GetBlock 8 params body → 200480481482
POST
/ledgers/{name}/digest
Amazon QLDB Get Digest
GetDigest 8 params → 200480481482
POST
/ledgers/{name}/revision
Amazon QLDB Get Revision
GetRevision 8 params body → 200480481482
GET
/ledgers/{name}/journal-kinesis-streams
Amazon QLDB List Journal Kinesis Streams For Ledger
ListJournalKinesisStreamsForLedger 12 params → 200480481482
POST
/ledgers/{name}/journal-kinesis-streams
Amazon QLDB Stream Journal To Kinesis
StreamJournalToKinesis 8 params body → 200480481482
PATCH
/ledgers/{name}/permissions-mode
Amazon QLDB Update Ledger Permissions Mode
UpdateLedgerPermissionsMode 8 params body → 200480481

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are JournalKinesisStreamDescription (11 properties), JournalS3ExportDescription (9 properties), DescribeLedgerResponse (7 properties), CreateLedgerResponse (7 properties). Each schema is shown below with its type and property counts.

JournalS3ExportDescription
object
Information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation…
9 properties 8 required
Boolean
boolean
ExportJournalToS3Response
object
1 property 1 required
ListJournalS3ExportsForLedgerResponse
object
2 properties
PermissionsMode
string
UniqueId
string
DeletionProtection
boolean
LedgerEncryptionDescription
object
Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in Key Management Service (KMS), and when…
3 properties 2 required
JournalKinesisStreamDescriptionList
array
CancelJournalKinesisStreamResponse
object
1 property
S3ObjectEncryptionType
string
ListJournalKinesisStreamsForLedgerResponse
object
2 properties
LimitExceededException
DescribeLedgerResponse
object
7 properties
JournalS3ExportList
array
S3EncryptionConfiguration
object
The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.
2 properties 1 required
LedgerSummary
object
Information about a ledger, including its name, state, and when it was created.
3 properties
LedgerState
string
StreamStatus
string
JournalKinesisStreamDescription
object
Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of th…
11 properties 6 required
Digest
string
LedgerList
array
StreamJournalToKinesisResponse
object
1 property
ResourceNotFoundException
S3ExportConfiguration
object
The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
3 properties 3 required
EncryptionStatus
string
S3Prefix
string
GetRevisionResponse
object
2 properties 1 required
ErrorCause
string
IonText
string
NextToken
string
GetBlockResponse
object
2 properties 1 required
ExportStatus
string
Timestamp
string
GetDigestResponse
object
2 properties 2 required
DescribeJournalKinesisStreamResponse
object
1 property
InvalidParameterException
ResourceAlreadyExistsException
LedgerName
string
ListLedgersResponse
object
2 properties
KinesisConfiguration
object
The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.
2 properties 1 required
Arn
string
StreamName
string
ResourcePreconditionNotMetException
DescribeJournalS3ExportResponse
object
1 property 1 required
UpdateLedgerResponse
object
6 properties
TagValue
string
ResourceInUseException
OutputFormat
string
S3Bucket
string
CreateLedgerResponse
object
7 properties
ValueHolder
object
A structure that can contain a value in multiple encoding formats.
1 property
UpdateLedgerPermissionsModeResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-qldb-ledgers-api-openapi.yml Raw ↑

Other APIs Amazon QLDB publishes across the network.

Amazon QLDB Journal S3 Exports API
AE Profile APIs.io
Amazon QLDB Tags API
AE Profile APIs.io
#Ledgers
← Back to A APIs
API Details
ID
amazon-qldb:amazon-qldb-ledgers-api
Base URL
https://qldb.amazonaws.com
Docs
https://aws.amazon.com/qldb/
Provider
Amazon QLDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=amazon-qldb-ledgers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/amazon-qldb-ledgers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Amazon QLDB Ledgers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.