Skip to main content

streams_list_only

Lists streams in a region or regions, for all properties use streams

Overview

Namestreams_list_only
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Idaws.kinesis.streams_list_only

Fields

NameDatatypeDescription
stream_mode_detailsobjectThe mode in which the stream is running.
stream_encryptionobjectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
arnstringThe Amazon resource name (ARN) of the Kinesis stream
retention_period_hoursintegerThe number of hours for the data records that are stored in shards to remain accessible.
tagsarrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
namestringThe name of the Kinesis stream.
shard_countintegerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all streams in a region.

SELECT
region,
name
FROM aws.kinesis.streams_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the streams_list_only resource, see streams