ListJournalKinesisStreamsForLedger - Amazon Quantum Ledger Database (Amazon QLDB)


Returns all Amazon QLDB journal streams for a given ledger.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams 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.

Request Syntax

GET /ledgers/name/journal-kinesis-streams?max_results=MaxResults&next_token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the ledger.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Required: Yes


The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

Valid Range: Minimum value of 1. Maximum value of 100.


A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here.

Length Constraints: Minimum length of 4. Maximum length of 1024.

Pattern: ^[A-Za-z-0-9+/=]+$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Streams": [ { "Arn": "string", "CreationTime": number, "ErrorCause": "string", "ExclusiveEndTime": number, "InclusiveStartTime": number, "KinesisConfiguration": { "AggregationEnabled": boolean, "StreamArn": "string" }, "LedgerName": "string", "RoleArn": "string", "Status": "string", "StreamId": "string", "StreamName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

  • If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved.

  • If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Pattern: ^[A-Za-z-0-9+/=]+$


The QLDB journal streams that are currently associated with the given ledger.

Type: Array of JournalKinesisStreamDescription objects


For information about the errors that are common to all actions, see Common Errors.


One or more parameters in the request aren't valid.

HTTP Status Code: 400


The specified resource doesn't exist.

HTTP Status Code: 404


The operation failed because a condition wasn't satisfied in advance.

HTTP Status Code: 412

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: