Skip to content

aws.qldb.list_journal_kinesis_streams_for_ledger

Example SQL Queries

SELECT * FROM
aws.qldb.list_journal_kinesis_streams_for_ledger
WHERE
"ledger_name" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
ledger_name Required Input Column

The name of the ledger.

VARCHAR
max_results Input Column

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

BIGINT
next_token Input Column
  • 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.

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
streams

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

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
streams[]
Show child fields
streams[].arn

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

streams[].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.)

streams[].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.

streams[].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.

streams[].inclusive_start_time

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

streams[].kinesis_configuration

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

Show child fields
streams[].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.

streams[].kinesis_configuration.stream_arn

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

streams[].ledger_name

The name of the ledger.

streams[].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.

streams[].status

The current state of the QLDB journal stream.

streams[].stream_id

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

streams[].stream_name

The user-defined name of the QLDB journal stream.