# Amazon QLDB API

> Amazon QLDB API on Apizie: 20 endpoints (Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon…, Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE…, Returns all ledgers that are associated with the current Amazon Web Services account and Region. This action…, Creates a new ledger in your Amazon Web Services account in the current Region., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-qldb`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-qldb
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-qldb/openapi.json

The resource management API for Amazon QLDB

## Endpoints

### Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/describe-journal-kinesis-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| streamId | string | yes | The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe. |

### Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/cancel-journal-kinesis-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| streamId | string | yes | The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled. |

### Returns all ledgers that are associated with the current Amazon Web Services account and Region. This action…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/list-ledgers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| max_results | integer | no | The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.) |
| next_token | string | no | A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates a new ledger in your Amazon Web Services account in the current Region.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/create-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/describe-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger that you want to describe. |

### Updates properties on a ledger.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/update-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

### Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/delete-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger that you want to delete. |

### Returns information about a journal export job, including the ledger name, export ID, creation time, current…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/describe-journal-s3-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| exportId | string | yes | The UUID (represented in Base62-encoded text) of the journal export job to describe. |

### Returns all journal export jobs for a specified ledger. This action returns a maximum of MaxResults items,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/list-journal-s3-exports-for-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| max_results | integer | no | The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be… |
| next_token | string | no | A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/export-journal-to-s3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

### Returns a block object at a specified address in a journal. Also returns a proof of the specified block for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/get-block` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

### Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/get-digest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |

### Returns a revision data object for a specified document ID and block address. Also returns a proof of the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/get-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

### Returns all Amazon QLDB journal streams for a given ledger. This action does not return any expired journal…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/list-journal-kinesis-streams-for-ledger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| max_results | integer | no | The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned… |
| next_token | string | no | A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/stream-journal-to-kinesis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

### Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/list-journal-s3-exports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| max_results | integer | no | The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.) |
| next_token | string | no | A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns all tags for a specified Amazon QLDB resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) for which to list the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger |

### Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) to which you want to add the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger |
| body | object | yes | JSON request body |

### Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) from which to remove the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger |
| tagKeys | array | yes | The list of tag keys to remove. |

### Updates the permissions mode of a ledger. Before you switch to the STANDARD permissions mode, you must first…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/update-ledger-permissions-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| name | string | yes | The name of the ledger. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/describe-journal-kinesis-stream" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon QLDB API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-qldb/describe-journal-kinesis-stream with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon QLDB API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon QLDB itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon QLDB API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-qldb.

### What is the status of the Amazon QLDB API?
Needs your own provider key (bring your own key)