Skip to content
AWS for Query.Farm

aws.kinesis.describe_stream_summary

Example SQL Queries

SELECT * FROM
aws.kinesis.describe_stream_summary;

Description

Provides a summarized description of the specified Kinesis data stream without the shard list.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

DescribeStreamSummary has a limit of 20 transactions per second per account.

Table Definition

Column NameColumn Data Type
stream_arn Input Column

The ARN of the stream.

VARCHAR
stream_name Input Column

The name of the 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_description_summary

A StreamDescriptionSummary containing information about the stream.

STRUCT(
    "stream_name" VARCHAR,
    "stream_arn" VARCHAR,
    "stream_status" VARCHAR,
    "stream_mode_details" STRUCT(
        "stream_mode" VARCHAR
    ),
    "retention_period_hours" BIGINT,
    "stream_creation_timestamp" TIMESTAMP_S,
    "enhanced_monitoring" STRUCT(
        "shard_level_metrics" VARCHAR[]
    )[],
    "encryption_type" VARCHAR,
    "key_id" VARCHAR,
    "open_shard_count" BIGINT,
    "consumer_count" BIGINT
)
Show child fields
stream_description_summary.consumer_count

The number of enhanced fan-out consumers registered with the stream.

stream_description_summary.encryption_type

The encryption type used. This value is one of the following:

  • KMS

  • NONE

stream_description_summary.enhanced_monitoring[]
Show child fields
stream_description_summary.enhanced_monitoring[].shard_level_metrics[]
stream_description_summary.key_id

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

stream_description_summary.open_shard_count

The number of open shards in the stream.

stream_description_summary.retention_period_hours

The current retention period, in hours.

stream_description_summary.stream_arn

The Amazon Resource Name (ARN) for the stream being described.

stream_description_summary.stream_creation_timestamp

The approximate time that the stream was created.

stream_description_summary.stream_mode_details

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.

Show child fields
stream_description_summary.stream_mode_details.stream_mode

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

stream_description_summary.stream_name

The name of the stream being described.

stream_description_summary.stream_status

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.