QLDB / Client / describe_journal_kinesis_stream

describe_journal_kinesis_stream

QLDB.Client.describe_journal_kinesis_stream(**kwargs)

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_journal_kinesis_stream(
    LedgerName='string',
    StreamId='string'
)

Parameters:

• LedgerName (string) –

  [REQUIRED]

  The name of the ledger.

• StreamId (string) –

  [REQUIRED]

  The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Stream': {
        'LedgerName': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'InclusiveStartTime': datetime(2015, 1, 1),
        'ExclusiveEndTime': datetime(2015, 1, 1),
        'RoleArn': 'string',
        'StreamId': 'string',
        'Arn': 'string',
        'Status': 'ACTIVE'|'COMPLETED'|'CANCELED'|'FAILED'|'IMPAIRED',
        'KinesisConfiguration': {
            'StreamArn': 'string',
            'AggregationEnabled': True|False
        },
        'ErrorCause': 'KINESIS_STREAM_NOT_FOUND'|'IAM_PERMISSION_REVOKED',
        'StreamName': 'string'
    }
}

Response Structure

• (dict) –

  • Stream (dict) –

    Information about the QLDB journal stream returned by a DescribeJournalS3Export 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

        Warning

        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.

Exceptions

• QLDB.Client.exceptions.InvalidParameterException

• QLDB.Client.exceptions.ResourceNotFoundException

• QLDB.Client.exceptions.ResourcePreconditionNotMetException