records
Creates, updates, deletes, gets or lists a records resource.
Overview
| Name | records |
| Type | Resource |
| Id | aws.keyspacesstreams.records |
Fields
The following fields are returned by SELECT queries:
- get_records
| Name | Datatype | Description |
|---|---|---|
change_records | array | An array of change data records retrieved from the specified shard. Each record represents a single data modification (insert, update, or delete) to a row in the Amazon Keyspaces table. Records include the primary key columns and information about what data was modified. |
iterator_description | object | Provides information about the current iterator at the time GetRecords request was processed by Keyspaces. |
next_shard_iterator | string | The next position in the shard from which to start sequentially reading data records. If null, the shard has been closed and the requested iterator will not return any more data. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_records | select | region | Retrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred. |
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_records
Retrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred.
SELECT
change_records,
iterator_description,
next_shard_iterator
FROM aws.keyspacesstreams.records
WHERE region = '{{ region }}' -- required
;