stream_summaries

Creates, updates, deletes, gets or lists a stream_summaries resource.

Overview

Name	stream_summaries
Type	Resource
Id	aws.kinesis.stream_summaries

Fields

The following fields are returned by SELECT queries:

describe_stream_summary

Name	Datatype	Description
consumer_count	integer	The number of enhanced fan-out consumers registered with the stream.
encryption_type	string	The encryption type used. This value is one of the following: KMS NONE (NONE, KMS)
enhanced_monitoring	array	Represents the current enhanced monitoring settings of the stream.
key_id	string	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
max_record_size_in_ki_b	integer	The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
open_shard_count	integer	The number of open shards in the stream.
retention_period_hours	integer	The current retention period, in hours.
stream_arn	string	The Amazon Resource Name (ARN) for the stream being described. (pattern: <code>arn:aws.:kinesis:.:\d{12}:stream/\S+</code>)
stream_creation_timestamp	string (date-time)	The approximate time that the stream was created.
stream_id	string	Not Implemented. Reserved for future use. (pattern: <code>[a-z0-9]{20}-[a-z0-9]{3}</code>)
stream_mode_details	object	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.
stream_name	string	The name of the stream being described. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
stream_status	string	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. (CREATING, DELETING, ACTIVE, UPDATING)
warm_throughput	object	The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_stream_summary	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_stream_summary

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.

SELECT
consumer_count,
encryption_type,
enhanced_monitoring,
key_id,
max_record_size_in_ki_b,
open_shard_count,
retention_period_hours,
stream_arn,
stream_creation_timestamp,
stream_id,
stream_mode_details,
stream_name,
stream_status,
warm_throughput
FROM aws.kinesis.stream_summaries
WHERE region = '{{ region }}' -- required
;