Table: aws_kinesis_consumer - Query AWS Kinesis Consumers using SQL

The AWS Kinesis Consumer is an entity within the AWS Kinesis service that allows you to process data from a Kinesis data stream. It retrieves records from the stream and passes them to your application for processing. This enables you to scale your processing resources to accommodate the rate of data flow from your Kinesis stream.

Table Usage Guide

The aws_kinesis_consumer table in Steampipe provides you with information about Kinesis Consumers within AWS Kinesis Data Streams. This table enables you, as a DevOps engineer, to query consumer-specific details, including consumer ARN, creation timestamp, and associated stream ARN. You can utilize this table to gather insights on consumers, such as details of the consumer, consumer status, and more. The schema outlines for you the various attributes of the Kinesis Consumer, including the consumer name, consumer status, consumer ARN, and associated tags.

Examples

Basic info

Explore the status of various streaming data consumers to understand their operational state and associated data streams. This is useful for monitoring the health and activity of data streaming services.

select
  consumer_name,
  consumer_arn,
  consumer_status,
  stream_arn
from
  aws_kinesis_consumer;

select
  consumer_name,
  consumer_arn,
  consumer_status,
  stream_arn
from
  aws_kinesis_consumer;

List consumers which are not in the active state

Determine the areas in which consumers are not currently active, allowing for targeted troubleshooting and system optimization.

select
  consumer_name,
  consumer_status,
  consumer_arn
from
  aws_kinesis_consumer
where
  consumer_status != 'ACTIVE'

select
  consumer_name,
  consumer_status,
  consumer_arn
from
  aws_kinesis_consumer
where
  consumer_status != 'ACTIVE'

Schema for aws_kinesis_consumer

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
account_id	text	=, !=, ~~, ~~, !~~, !~~	The AWS Account ID in which the resource is located.
akas	jsonb		Array of globally unique identifier strings (also known as) for the resource.
consumer_arn	text	=	An ARN generated by Kinesis Data Streams when consumer is registered.
consumer_creation_timestamp	timestamp with time zone		Timestamp when consumer was created.
consumer_name	text		The name of the consumer.
consumer_status	text		The current status of consumer.
partition	text		The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
region	text		The AWS Region in which the resource is located.
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
stream_arn	text		The ARN of the stream with which you registered the consumer.
title	text		Title of the resource.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- aws

You can pass the configuration to the command with the --config argument:

steampipe_export_aws --config '<your_config>' aws_kinesis_consumer