Network.AWS.DynamoDBStreams.GetShardIterator

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.

See: AWS API Reference for GetShardIterator.

Creating a Request

getShardIterator

Arguments

:: Text

gsiStreamARN

-> Text

gsiShardId

-> ShardIteratorType

gsiShardIteratorType

-> GetShardIterator

Creates a value of GetShardIterator with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsiSequenceNumber
• gsiStreamARN
• gsiShardId
• gsiShardIteratorType

data GetShardIterator

Represents the input of a GetShardIterator operation.

See: getShardIterator smart constructor.

Instances

Eq GetShardIterator

Data GetShardIterator

Read GetShardIterator

Show GetShardIterator

Generic GetShardIterator

ToJSON GetShardIterator

AWSRequest GetShardIterator

ToPath GetShardIterator

ToHeaders GetShardIterator

ToQuery GetShardIterator

Typeable * GetShardIterator

type Rep GetShardIterator

type Rs GetShardIterator = GetShardIteratorResponse

Request Lenses

gsiSequenceNumber :: Lens' GetShardIterator (Maybe Text)

The sequence number of a stream record in the shard from which to start reading.

gsiStreamARN :: Lens' GetShardIterator Text

The Amazon Resource Name (ARN) for the stream.

gsiShardId :: Lens' GetShardIterator Text

The identifier of the shard. The iterator will be returned for this shard ID.

gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.
• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.
• LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

Destructuring the Response

getShardIteratorResponse

Arguments

:: Int

gsirsStatus

-> GetShardIteratorResponse

Creates a value of GetShardIteratorResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsirsShardIterator
• gsirsStatus

data GetShardIteratorResponse

Represents the output of a GetShardIterator operation.

See: getShardIteratorResponse smart constructor.

Instances

Eq GetShardIteratorResponse

Data GetShardIteratorResponse

Read GetShardIteratorResponse

Show GetShardIteratorResponse

Generic GetShardIteratorResponse

Typeable * GetShardIteratorResponse

type Rep GetShardIteratorResponse

Response Lenses

gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text)

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.

gsirsStatus :: Lens' GetShardIteratorResponse Int

The response status code.