shard_iterators
Creates, updates, deletes, gets or lists a shard_iterators resource.
Overview
| Name | shard_iterators |
| Type | Resource |
| Id | aws.keyspacesstreams.shard_iterators |
Fields
The following fields are returned by SELECT queries:
- get_shard_iterator
| Name | Datatype | Description |
|---|---|---|
shard_iterator | string | The unique identifier for the shard iterator. This value is used in the GetRecords operation to retrieve data records from the specified shard. Each shard iterator expires 15 minutes after it is returned to the requester. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_shard_iterator | select | region | Returns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard. The shard iterator specifies the shard position from which to start reading data records sequentially. You can specify whether to begin reading at the latest record, the oldest record, or at a particular sequence number within the shard. |
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_shard_iterator
Returns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard. The shard iterator specifies the shard position from which to start reading data records sequentially. You can specify whether to begin reading at the latest record, the oldest record, or at a particular sequence number within the shard.
SELECT
shard_iterator
FROM aws.keyspacesstreams.shard_iterators
WHERE region = '{{ region }}' -- required
;