QLDB / Client / list_journal_kinesis_streams_for_ledger



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.

See also: AWS API Documentation

Request Syntax

response = client.list_journal_kinesis_streams_for_ledger(
  • LedgerName (string) –


    The name of the ledger.

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

  • NextToken (string) – 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.

Return type:



Response Syntax

    'Streams': [
            'LedgerName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'InclusiveStartTime': datetime(2015, 1, 1),
            'ExclusiveEndTime': datetime(2015, 1, 1),
            'RoleArn': 'string',
            'StreamId': 'string',
            'Arn': 'string',
            'KinesisConfiguration': {
                'StreamArn': 'string',
                'AggregationEnabled': True|False
            'StreamName': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • Streams (list) –

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

      • (dict) –

        Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

        • LedgerName (string) –

          The name of the ledger.

        • CreationTime (datetime) –

          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 (datetime) –

          The inclusive start date and time from which to start streaming journal data.

        • ExclusiveEndTime (datetime) –

          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) –

          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) –

          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 (string) –

          The current state of the QLDB journal stream.

        • KinesisConfiguration (dict) –

          The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

          • StreamArn (string) –

            The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

          • AggregationEnabled (boolean) –

            Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

            Default: True


            Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

        • ErrorCause (string) –

          The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

        • StreamName (string) –

          The user-defined name of the QLDB journal stream.

    • NextToken (string) –

      • 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.