shard_iterators

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

Overview

Name	shard_iterators
Type	Resource
Id	aws.dynamodbstreams.shard_iterators

Fields

The following fields are returned by SELECT queries:

get_shard_iterator

Name	Datatype	Description
shard_iterator	string	The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.

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. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard. A shard iterator expires 15 minutes after it is returned to the requester.

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. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard. A shard iterator expires 15 minutes after it is returned to the requester.

SELECT
shard_iterator
FROM aws.dynamodbstreams.shard_iterators
WHERE region = '{{ region }}' -- required
;