Skip to content
AWS for Query.Farm

aws.qldb.describe_journal_kinesis_stream

Example SQL Queries

SELECT * FROM
aws.qldb.describe_journal_kinesis_stream
WHERE
"ledger_name" = 'VALUE'
AND "stream_id" = 'VALUE';

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

Table Definition

Column NameColumn Data Type
ledger_name Required Input Column

The name of the ledger.

VARCHAR
stream_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
stream

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

STRUCT(
    "ledger_name" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "inclusive_start_time" TIMESTAMP_S,
    "exclusive_end_time" TIMESTAMP_S,
    "role_arn" VARCHAR,
    "stream_id" VARCHAR,
    "arn" VARCHAR,
    "status" VARCHAR,
    "kinesis_configuration" STRUCT(
        "stream_arn" VARCHAR,
        "aggregation_enabled" BOOLEAN
    ),
    "error_cause" VARCHAR,
    "stream_name" VARCHAR
)
Show child fields
stream.arn

The Amazon Resource Name (ARN) of the QLDB journal stream.

stream.creation_time

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

stream.error_cause

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.

stream.exclusive_end_time

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

stream.inclusive_start_time

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

stream.kinesis_configuration

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

Show child fields
stream.kinesis_configuration.aggregation_enabled

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.

stream.kinesis_configuration.stream_arn

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

stream.ledger_name

The name of the ledger.

stream.role_arn

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.

stream.status

The current state of the QLDB journal stream.

stream.stream_id

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

stream.stream_name

The user-defined name of the QLDB journal stream.