DescribeJournalKinesisStream - Amazon Quantum Ledger Database (Amazon QLDB)


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.

Request Syntax

GET /ledgers/name/journal-kinesis-streams/streamId 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 UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.

Length Constraints: Fixed length of 22.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Stream": { "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.


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

Type: JournalKinesisStreamDescription object


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: