---
title: "GET /ledgers/{name}/journal-kinesis-streams"
method: GET
path: "/ledgers/{name}/journal-kinesis-streams"
---

# GET /ledgers/{name}/journal-kinesis-streams

`GET /ledgers/{name}/journal-kinesis-streams`

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 does not return any expired journal streams. For more information, see [Expiration for terminal streams](https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) in the _Amazon QLDB Developer Guide_.

This action returns a maximum of `MaxResults` items. It is paginated so that you can retrieve all the items by calling `ListJournalKinesisStreamsForLedger` multiple times.

## Path parameters

- `name` string, required

## Query parameters

- `max_results` integer
- `next_token` string
- `MaxResults` string
- `NextToken` string

## Response `200`

Success

- ListJournalKinesisStreamsForLedgerResponse
  - `Streams` JournalKinesisStreamDescription[] — The array of QLDB journal stream descriptors that are associated with the given ledger.
    - `LedgerName` string, required — The name of the ledger.
    - `CreationTime` string, date-time — The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
    - `InclusiveStartTime` string, date-time — The inclusive start date and time from which to start streaming journal data.
    - `ExclusiveEndTime` string, date-time — The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
    - `RoleArn` string, required — The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
    - `StreamId` string, required — The UUID (represented in Base62-encoded text) of the QLDB journal stream.
    - `Arn` string — The Amazon Resource Name (ARN) of the QLDB journal stream.
    - `Status` 'ACTIVE' | 'COMPLETED' | 'CANCELED' | 'FAILED' | 'IMPAIRED', required — The current state of the QLDB journal stream.
    - `KinesisConfiguration` object, required — The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
      - `StreamArn` string, required — The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
      - `AggregationEnabled` boolean — <p>Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.</p> <p> <i>This option is enabled by default.</i> Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see <a href="https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html">KPL Key Concepts</a> and <a href="https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html">Consumer De-aggregation</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>
    - `ErrorCause` 'KINESIS_STREAM_NOT_FOUND' | 'IAM_PERMISSION_REVOKED' — The error message that describes the reason that a stream has a status of <code>IMPAIRED</code> or <code>FAILED</code>. This is not applicable to streams that have other status values.
    - `StreamName` string, required — The user-defined name of the QLDB journal stream.
  - `NextToken` string — <ul> <li> <p>If <code>NextToken</code> is empty, the last page of results has been processed and there are no more results to be retrieved.</p> </li> <li> <p>If <code>NextToken</code> is <i>not</i> empty, more results are available. To retrieve the next page of results, use the value of <code>NextToken</code> in a subsequent <code>ListJournalKinesisStreamsForLedger</code> call.</p> </li> </ul>

## Other responses

- `480` — InvalidParameterException
- `481` — ResourceNotFoundException
- `482` — ResourcePreconditionNotMetException

---

[API](https://skmtc.net/aws/apis/qldb.md) · [All operations](https://skmtc.net/aws/apis/qldb/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qldb/versions/40f98f4993d2/schema)