Copyright	Copyright (c) 2013-2014 PivotCloud, Inc.
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Aws.DynamoDb.Streams.Commands.GetShardIterator

Contents

Request
- Lenses
Response
- Lenses

Description

Synopsis

Request

data GetShardIterator Source

A shard iterator provides information about how to retrieve stream records from within a shard. Note: A shard iterator expires 15 minutes after it is returned to the requester.

Constructors

GetShardIterator
Fields _gsiSequenceNumber :: !(Maybe SequenceNumber) The sequence number of a stream record in the shard from which to start reading. _gsiShardId :: !ShardId The identifier of the shard. _gsiShardIteratorType :: !ShardIteratorType Determines how the shard iterator is used to start reading stream records from the shard. _gsiStreamId :: !StreamId

getShardIterator :: StreamId -> ShardId -> ShardIteratorType -> GetShardIterator Source

A basic GetShardIterator request for a given stream id.

myRequest =
  getShardIterator myStream myShard ShardIteratorLatest
    & gsiSequenceNumber ?~ sqn

Lenses

gsiSequenceNumber :: Functor f => (Maybe SequenceNumber -> f (Maybe SequenceNumber)) -> GetShardIterator -> f GetShardIterator Source

A lens for _gsiSequenceNumber.

gsiSequenceNumber ∷ Lens' GetShardIterator (Maybe SequenceNumber)

gsiShardId :: Functor f => (ShardId -> f ShardId) -> GetShardIterator -> f GetShardIterator Source

A lens for _gsiShardId.

gsiShardId ∷ Lens' GetShardIterator ShardId

gsiShardIteratorType :: Functor f => (ShardIteratorType -> f ShardIteratorType) -> GetShardIterator -> f GetShardIterator Source

A lens for _gsiShardIteratorType.

gsiShardIteratorType ∷ Lens' GetShardIterator ShardIteratorType

gsiStreamId :: Functor f => (StreamId -> f StreamId) -> GetShardIterator -> f GetShardIterator Source

A lens for _gsiStreamId.

gsiStreamId ∷ Lens' GetShardIterator StreamId

Response

Lenses

gsirShardIterator :: Functor f => (ShardIterator -> f ShardIterator) -> GetShardIteratorResponse -> f GetShardIteratorResponse Source

A lens for _gsirShardIterator.

gsirShardIterator ∷ Lens' GetShardIteratorResponse ShardIterator

Eq GetShardIterator
Ord GetShardIterator
Read GetShardIterator
Show GetShardIterator
ToJSON GetShardIterator
FromJSON GetShardIterator
SignQuery GetShardIterator
Typeable * GetShardIterator
Transaction GetShardIterator GetShardIteratorResponse
type ServiceConfiguration GetShardIterator = StreamsConfiguration

Eq GetShardIteratorResponse
Ord GetShardIteratorResponse
Read GetShardIteratorResponse
Show GetShardIteratorResponse
ToJSON GetShardIteratorResponse
FromJSON GetShardIteratorResponse
AsMemoryResponse GetShardIteratorResponse
Typeable * GetShardIteratorResponse
ResponseConsumer r GetShardIteratorResponse
Transaction GetShardIterator GetShardIteratorResponse
type ResponseMetadata GetShardIteratorResponse = StreamsMetadata
type MemoryResponse GetShardIteratorResponse = GetShardIteratorResponse

GetShardIteratorResponse
Fields _gsirShardIterator :: !ShardIterator