Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qldb ]

describe-journal-kinesis-stream

Description

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 your original stream creation request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-journal-kinesis-stream
--ledger-name <value>
--stream-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ledger-name (string)

The name of the ledger.

--stream-id (string)

The unique ID that QLDB assigns to each QLDB journal stream.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe a journal stream

The following describe-journal-kinesis-stream example displays the details for the specified journal stream from a ledger.

aws qldb describe-journal-kinesis-stream \
    --ledger-name myExampleLedger \
    --stream-id 7ISCkqwe4y25YyHLzYUFAf

Output:

{
    "Stream": {
        "LedgerName": "myExampleLedger",
        "CreationTime": 1591221984.677,
        "InclusiveStartTime": 1590710400.0,
        "ExclusiveEndTime": 1590796799.0,
        "RoleArn": "arn:aws:iam::123456789012:role/my-kinesis-stream-role",
        "StreamId": "7ISCkqwe4y25YyHLzYUFAf",
        "Arn": "arn:aws:qldb:us-east-1:123456789012:stream/myExampleLedger/7ISCkqwe4y25YyHLzYUFAf",
        "Status": "ACTIVE",
        "KinesisConfiguration": {
            "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
            "AggregationEnabled": true
        },
        "StreamName": "myExampleLedger-stream"
    }
}

For more information, see Streaming journal data from Amazon QLDB in the Amazon QLDB Developer Guide.

Output

Stream -> (structure)

Information about the QLDB journal stream returned by a DescribeJournalS3Export request.

LedgerName -> (string)

The name of the ledger.

CreationTime -> (timestamp)

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 -> (timestamp)

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

ExclusiveEndTime -> (timestamp)

The exclusive date and time that specifies when the stream ends. If this parameter is blank, 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 unique ID that QLDB assigns to each 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 -> (structure)

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

StreamArn -> (string)

The Amazon Resource Name (ARN) of the Kinesis data stream resource.

AggregationEnabled -> (boolean)

Enables QLDB to publish multiple data records in a single Kinesis Data Streams record. To learn more, see KPL Key Concepts 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.