streams

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

Overview

Name	streams
Type	Resource
Id	aws.keyspacesstreams.streams

Fields

The following fields are returned by SELECT queries:

get_stream

Name	Datatype	Description
parent_shard_ids	array	The identifiers of parent shards that this shard evolved from, if this shard was created through resharding.
sequence_number_range	object	The range of sequence numbers contained within this shard.
shard_id	string	A unique identifier for this shard within the stream.

list_streams

Name	Datatype	Description
keyspace_name	string	The name of the keyspace containing the table associated with this stream. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_]{0,47}</code>)
stream_arn	string	The Amazon Resource Name (ARN) that uniquely identifies this stream.
stream_label	string	A unique identifier for this stream that can be used in stream operations.
table_name	string	The name of the table associated with this stream. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_]{0,47}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_stream	select	region		Returns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream's Amazon Resource Name (ARN), creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.
list_streams	select	region		Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.

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

get_stream

Returns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream's Amazon Resource Name (ARN), creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.

SELECT
parent_shard_ids,
sequence_number_range,
shard_id
FROM aws.keyspacesstreams.streams
WHERE region = '{{ region }}' -- required
;

list_streams

Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.

SELECT
keyspace_name,
stream_arn,
stream_label,
table_name
FROM aws.keyspacesstreams.streams
WHERE region = '{{ region }}' -- required
;