Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
Synopsis
- getShardIterator :: Text -> Text -> ShardIteratorType -> GetShardIterator
- data GetShardIterator
- gsiSequenceNumber :: Lens' GetShardIterator (Maybe Text)
- gsiStreamARN :: Lens' GetShardIterator Text
- gsiShardId :: Lens' GetShardIterator Text
- gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType
- getShardIteratorResponse :: Int -> GetShardIteratorResponse
- data GetShardIteratorResponse
- gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text)
- gsirsResponseStatus :: Lens' GetShardIteratorResponse Int
Creating a Request
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
- The sequence number of a stream record in the shard from which to start reading.gsiStreamARN
- The Amazon Resource Name (ARN) for the stream.gsiShardId
- The identifier of the shard. The iterator will be returned for this shard ID.gsiShardIteratorType
- 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.
data GetShardIterator Source #
Represents the input of a GetShardIterator
operation.
See: getShardIterator
smart constructor.
Instances
Request Lenses
gsiSequenceNumber :: Lens' GetShardIterator (Maybe Text) Source #
The sequence number of a stream record in the shard from which to start reading.
gsiStreamARN :: Lens' GetShardIterator Text Source #
The Amazon Resource Name (ARN) for the stream.
gsiShardId :: Lens' GetShardIterator Text Source #
The identifier of the shard. The iterator will be returned for this shard ID.
gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType Source #
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 Source #
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
- 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.gsirsResponseStatus
- -- | The response status code.
data GetShardIteratorResponse Source #
Represents the output of a GetShardIterator
operation.
See: getShardIteratorResponse
smart constructor.
Instances
Response Lenses
gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text) Source #
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.
gsirsResponseStatus :: Lens' GetShardIteratorResponse Int Source #
- - | The response status code.