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

Aws.DynamoDb.Streams.Types

Contents

Sequence Numbers
Shards
- Lenses
Shard Iterators
- Prisms
Attribute Values
- Prisms
Key Schemas
- Key Types
  - Prisms
- Key Schema Elements
  - Lenses
Records
Stream Metadata
- Stream Statuses
- Stream Description
  - Lenses

Description

Synopsis

Sequence Numbers

data SequenceNumber Source

Identifier for a record.

Length constraints: 21 ≤ n ≤ 40

Instances

Eq SequenceNumber
Ord SequenceNumber
Read SequenceNumber
Show SequenceNumber
ToJSON SequenceNumber
FromJSON SequenceNumber
Typeable * SequenceNumber

data SequenceNumberRange Source

The beginning and ending sequence numbers for the stream records contained within a shard.

Constructors

SequenceNumberRange
Fields _sqnrStartingSequenceNumber :: !(Maybe SequenceNumber) _sqnrEndingSequenceNumber :: !(Maybe SequenceNumber)

Instances

Eq SequenceNumberRange
Ord SequenceNumberRange
Read SequenceNumberRange
Show SequenceNumberRange
ToJSON SequenceNumberRange
FromJSON SequenceNumberRange
Typeable * SequenceNumberRange

sqnrStartingSequenceNumber :: Functor f => (Maybe SequenceNumber -> f (Maybe SequenceNumber)) -> SequenceNumberRange -> f SequenceNumberRange Source

A lens for _sqnrStartingSequenceNumber.

sqnrStartingSequenceNumber ∷ Lens' SequenceNumberRange (Maybe SequenceNumber)

sqnrEndingSequenceNumber :: Functor f => (Maybe SequenceNumber -> f (Maybe SequenceNumber)) -> SequenceNumberRange -> f SequenceNumberRange Source

A lens for _sqnrEndingSequenceNumber.

sqnrEndingSequenceNumber ∷ Lens' SequenceNumberRange (Maybe SequenceNumber)

Shards

data ShardId Source

Identifier for a shard.

Length constraints: 28 ≤ n ≤ 65.

Instances

Eq ShardId
Ord ShardId
Read ShardId
Show ShardId
ToJSON ShardId
FromJSON ShardId
Typeable * ShardId

data Shard Source

A uniquely identified group of stream records within a stream.

Constructors

Shard
Fields _shShardId :: !(Maybe ShardId) The system-generated identifier for this shard _shParentShardId :: !(Maybe ShardId) The shard ID of this shard's parent _shSequenceNumberRange :: !(Maybe SequenceNumberRange) The range of possible sequence numbers for this shard

Instances

Eq Shard
Ord Shard
Read Shard
Show Shard
ToJSON Shard
FromJSON Shard
Typeable * Shard
ListResponse DescribeStreamResponse Shard

Lenses

shShardId :: Functor f => (Maybe ShardId -> f (Maybe ShardId)) -> Shard -> f Shard Source

A lens for _shShardId.

shshardId ∷ Lens' Shard (Maybe ShardId)

shParentShardId :: Functor f => (Maybe ShardId -> f (Maybe ShardId)) -> Shard -> f Shard Source

A lens for _shParentShardId.

shParentShardId ∷ Lens' Shard (Maybe ShardId)

shSequenceNumberRange :: Functor f => (Maybe SequenceNumberRange -> f (Maybe SequenceNumberRange)) -> Shard -> f Shard Source

A lens for _shSequenceNumberRange.

shSequenceNumberRange ∷ Lens' Shard (Maybe SequenceNumberRange)

Shard Iterators

data ShardIterator 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.

Length constraints: 1 ≤ n ≤ 2048.

Instances

Eq ShardIterator
Ord ShardIterator
Read ShardIterator
Show ShardIterator
ToJSON ShardIterator
FromJSON ShardIterator
Typeable * ShardIterator

Prisms

_ShardIteratorTrimHorizon :: (Choice p, Applicative f) => p () (f ()) -> p ShardIteratorType (f ShardIteratorType) Source

A prism for ShardIteratorTrimHorizon.

_ShardIteratorTrimHorizon ∷ Prism' ShardIteratorType '()'

_ShardIteratorLatest :: (Choice p, Applicative f) => p () (f ()) -> p ShardIteratorType (f ShardIteratorType) Source

A prism for ShardIteratorLatest.

_ShardIteratorLatest ∷ Prism' ShardIteratorType '()'

_ShardIteratorAtSequenceNumber :: (Choice p, Applicative f) => p () (f ()) -> p ShardIteratorType (f ShardIteratorType) Source

A prism for ShardIteratorAtSequenceNumber.

_ShardIteratorAtSequenceNumber ∷ Prism' ShardIteratorType '()'

_ShardIteratorAfterSequenceNumber :: (Choice p, Applicative f) => p () (f ()) -> p ShardIteratorType (f ShardIteratorType) Source

A prism for ShardIteratorAfterSequenceNumber.

_ShardIteratorAfterSequenceNumber ∷ Prism' ShardIteratorType '()'

Attribute Values

data AttributeValue Source

Represents the data for an attribute.

Constructors

AVBin !ByteString	Binary data will automatically be base64 marshalled
AVBool !Bool
AVBinSet !(Set ByteString)	Binary data will automatically be base64 marshalled
AVList ![AttributeValue]
AVMap !(Map Text AttributeValue)
AVNum !Scientific
AVNumSet !(Set Scientific)
AVNull !Bool
AVString !Text
AVStringSet !(Set Text)

Instances

Eq AttributeValue
Ord AttributeValue
Read AttributeValue
Show AttributeValue
ToJSON AttributeValue
FromJSON AttributeValue
Typeable * AttributeValue

Prisms

_AVBin :: (Choice p, Applicative f) => p ByteString (f ByteString) -> p AttributeValue (f AttributeValue) Source

A prism for AVBin.

_AVBin ∷ Prism' AttributeValue ByteString

_AVBool :: (Choice p, Applicative f) => p Bool (f Bool) -> p AttributeValue (f AttributeValue) Source

A prism for AVBool.

_AVBool ∷ Prism' AttributeValue Bool

_AVBinSet :: (Choice p, Applicative f) => p (Set ByteString) (f (Set ByteString)) -> p AttributeValue (f AttributeValue) Source

A prism for AVBinSet.

_AVBinSet ∷ Prism' AttributeValue (Set ByteString)

_AVList :: (Choice p, Applicative f) => p [AttributeValue] (f [AttributeValue]) -> p AttributeValue (f AttributeValue) Source

A prism for AVList.

_AVList ∷ Prism' AttributeValue [AttributeValue]

_AVMap :: (Choice p, Applicative f) => p (Map Text AttributeValue) (f (Map Text AttributeValue)) -> p AttributeValue (f AttributeValue) Source

A prism for AVMap.

_AVMap ∷ Prism' AttributeValue (Map Text AttributeValue)

_AVNum :: (Choice p, Applicative f) => p Scientific (f Scientific) -> p AttributeValue (f AttributeValue) Source

A prism for AVNum.

_AVNum ∷ Prism' AttributeValue Scientific

_AVNumSet :: (Choice p, Applicative f) => p (Set Scientific) (f (Set Scientific)) -> p AttributeValue (f AttributeValue) Source

A prism for AVNumSet.

_AVNumSet ∷ Prism' AttributeValue (Set Scientific)

_AVNull :: (Choice p, Applicative f) => p Bool (f Bool) -> p AttributeValue (f AttributeValue) Source

A prism for AVNull.

_AVNull ∷ Prism' AttributeValue Bool

_AVString :: (Choice p, Applicative f) => p Text (f Text) -> p AttributeValue (f AttributeValue) Source

A prism for AVString.

_AVString ∷ Prism' AttributeValue Text

_AVStringSet :: (Choice p, Applicative f) => p (Set Text) (f (Set Text)) -> p AttributeValue (f AttributeValue) Source

A prism for AVStringSet.

_AVStringSet ∷ Prism' AttributeValue (Set Text)

Key Schemas

Key Types

data KeyType Source

Constructors

KeyTypeHash
KeyTypeRange

Instances

Enum KeyType
Eq KeyType
Ord KeyType
Read KeyType
Show KeyType
ToJSON KeyType
FromJSON KeyType
Typeable * KeyType

keyTypeToText :: IsString s => KeyType -> s Source

Prisms

_KeyTypeHash :: (Choice p, Applicative f) => p () (f ()) -> p KeyType (f KeyType) Source

A prism for KeyTypeHash.

_KeyTypeHash ∷ Prism' KeyType ()

_KeyTypeRange :: (Choice p, Applicative f) => p () (f ()) -> p KeyType (f KeyType) Source

A prism for KeyTypeRange.

_KeyTypeRange ∷ Prism' KeyType ()

Key Schema Elements

data KeySchemaElement Source

Constructors

KeySchemaElement
Fields _kseAttributeName :: !Text _kseKeyType :: !KeyType

Instances

Eq KeySchemaElement
Ord KeySchemaElement
Read KeySchemaElement
Show KeySchemaElement
ToJSON KeySchemaElement
FromJSON KeySchemaElement
Typeable * KeySchemaElement

Lenses

kseAttributeName :: Functor f => (Text -> f Text) -> KeySchemaElement -> f KeySchemaElement Source

A lens for _kseAttributeName.

kseAttributeName ∷ Lens' KeySchemaElement Text

kseKeyType :: Functor f => (KeyType -> f KeyType) -> KeySchemaElement -> f KeySchemaElement Source

A lens for _kseKeyType.

kseKeyType ∷ Lens' KeySchemaElement KeyType

Records

Stream View Types

data StreamViewType Source

Constructors

StreamViewKeysOnly	only the key attributes of the modified item
StreamViewNewImage	the entire item, as it appears after it was modified
StreamViewOldImage	the entire item, as it appeared before it was modified
StreamViewNewAndOldImages	both the new and the old images of the item

Instances

Enum StreamViewType
Eq StreamViewType
Ord StreamViewType
Read StreamViewType
Show StreamViewType
ToJSON StreamViewType
FromJSON StreamViewType
Typeable * StreamViewType

Prisms

_StreamViewKeysOnly :: (Choice p, Applicative f) => p () (f ()) -> p StreamViewType (f StreamViewType) Source

A prism for StreamViewKeysOnly.

_StreamViewKeysOnly ∷ Prism' StreamViewType ()

_StreamViewNewImage :: (Choice p, Applicative f) => p () (f ()) -> p StreamViewType (f StreamViewType) Source

A prism for StreamViewNewImage.

_StreamViewNewImage ∷ Prism' StreamViewType ()

_StreamViewOldImage :: (Choice p, Applicative f) => p () (f ()) -> p StreamViewType (f StreamViewType) Source

A prism for StreamViewOldImage.

_StreamViewOldImage ∷ Prism' StreamViewType ()

_StreamViewNewAndOldImages :: (Choice p, Applicative f) => p () (f ()) -> p StreamViewType (f StreamViewType) Source

A prism for StreamViewNewAndOldImages.

_StreamViewNewAndOldImages ∷ Prism' StreamViewType ()

Stream Records

data StreamRecord Source

Constructors

StreamRecord
Fields _strKeys :: !(Maybe (Map Text AttributeValue)) _strNewImage :: !(Maybe (Map Text AttributeValue)) _strOldImage :: !(Maybe (Map Text AttributeValue)) _strSequenceNumber :: !(Maybe SequenceNumber) _strSizeBytes :: !(Maybe Integer) _strStreamViewType :: !(Maybe StreamViewType)

Instances

Eq StreamRecord
Ord StreamRecord
Read StreamRecord
Show StreamRecord
ToJSON StreamRecord
FromJSON StreamRecord
Typeable * StreamRecord

Lenses

strKeys :: Functor f => (Maybe (Map Text AttributeValue) -> f (Maybe (Map Text AttributeValue))) -> StreamRecord -> f StreamRecord Source

A lens for _strKeys.

strKeys ∷ Lens' StreamRecord (Maybe (Map Text AttributeValue))

strNewImage :: Functor f => (Maybe (Map Text AttributeValue) -> f (Maybe (Map Text AttributeValue))) -> StreamRecord -> f StreamRecord Source

A lens for _strNewImage.

strNewImage ∷ Lens' StreamRecord (Maybe (Map Text AttributeValue))

strOldImage :: Functor f => (Maybe (Map Text AttributeValue) -> f (Maybe (Map Text AttributeValue))) -> StreamRecord -> f StreamRecord Source

A lens for _strOldImage.

strOldImage ∷ Lens' StreamRecord (Maybe (Map Text AttributeValue))

strSequenceNumber :: Functor f => (Maybe SequenceNumber -> f (Maybe SequenceNumber)) -> StreamRecord -> f StreamRecord Source

A lens for _strSequenceNumber.

strSequenceNumber ∷ Lens' StreamRecord (Maybe SequenceNumber)

strSizeBytes :: Functor f => (Maybe Integer -> f (Maybe Integer)) -> StreamRecord -> f StreamRecord Source

A lens for _strSizeBytes.

strSizeBytes ∷ Lens' StreamRecord (Maybe Integer)

strStreamViewType :: Functor f => (Maybe StreamViewType -> f (Maybe StreamViewType)) -> StreamRecord -> f StreamRecord Source

A lens for _strStreamViewType.

strStreamViewType ∷ Lens' StreamRecord (Maybe StreamViewType)

Event Names

data EventName Source

Constructors

EventInsert
EventModify
EventRemove

Instances

Enum EventName
Eq EventName
Ord EventName
Read EventName
Show EventName
ToJSON EventName
FromJSON EventName
Typeable * EventName

Prisms

_EventInsert :: (Choice p, Applicative f) => p () (f ()) -> p EventName (f EventName) Source

A prism for EventInsert.

_EventInsert ∷ Prism' EventName ()

_EventModify :: (Choice p, Applicative f) => p () (f ()) -> p EventName (f EventName) Source

A prism for EventModify.

_EventModify ∷ Prism' EventName ()

_EventRemove :: (Choice p, Applicative f) => p () (f ()) -> p EventName (f EventName) Source

A prism for EventRemove.

_EventRemove ∷ Prism' EventName ()

Records

data Record Source

Constructors

Record
Fields _rAwsRegion :: !(Maybe Region) _rStreamRecord :: !(Maybe StreamRecord) _rEventId :: !(Maybe EventId) _rEventName :: !(Maybe EventName) _rEventSource :: !(Maybe Text) _rEventVersion :: !(Maybe Text)

Instances

Eq Record
Ord Record
Read Record
Show Record
ToJSON Record
FromJSON Record
Typeable * Record
ListResponse GetRecordsResponse Record

Lenses

rAwsRegion :: Functor f => (Maybe Region -> f (Maybe Region)) -> Record -> f Record Source

A lens for _rAwsRegion.

rAwsRegion ∷ Lens' Record (Maybe Region)

rStreamRecord :: Functor f => (Maybe StreamRecord -> f (Maybe StreamRecord)) -> Record -> f Record Source

A lens for _rStreamRecord.

rStreamRecord ∷ Lens' Record (Maybe StreamRecord)

rEventId :: Functor f => (Maybe EventId -> f (Maybe EventId)) -> Record -> f Record Source

A lens for _rEventId.

rEventId ∷ Lens' Record (Maybe EventId)

rEventName :: Functor f => (Maybe EventName -> f (Maybe EventName)) -> Record -> f Record Source

A lens for _rEventName.

rEventName ∷ Lens' Record (Maybe EventName)

rEventSource :: Functor f => (Maybe Text -> f (Maybe Text)) -> Record -> f Record Source

A lens for _rEventSource.

rEventSource ∷ Lens' Record (Maybe Text)

rEventVersion :: Functor f => (Maybe Text -> f (Maybe Text)) -> Record -> f Record Source

A lens for _rEventVersion.

rEventVersion ∷ Lens' Record (Maybe Text)

Stream Metadata

Stream Statuses

data StreamStatus Source

Constructors

StatusEnabling	DynamoDB Streams is currently being enabled on the table
StatusEnabled	The stream is enabled
StatusDisabling	DynamoDB Streams is currently being disabled on the table
StatusDisabled	The stream is disabled

Instances

Enum StreamStatus
Eq StreamStatus
Ord StreamStatus
Read StreamStatus
Show StreamStatus
ToJSON StreamStatus
FromJSON StreamStatus
Typeable * StreamStatus

_StatusEnabling :: (Choice p, Applicative f) => p () (f ()) -> p StreamStatus (f StreamStatus) Source

A prism for StatusEnabling.

_StatusEnabling ∷ Prism' StreamStatus ()

_StatusEnabled :: (Choice p, Applicative f) => p () (f ()) -> p StreamStatus (f StreamStatus) Source

A prism for StatusEnabled.

_StatusEnabled ∷ Prism' StreamStatus ()

_StatusDisabling :: (Choice p, Applicative f) => p () (f ()) -> p StreamStatus (f StreamStatus) Source

A prism for StatusDisabling.

_StatusDisabling ∷ Prism' StreamStatus ()

_StatusDisabled :: (Choice p, Applicative f) => p () (f ()) -> p StreamStatus (f StreamStatus) Source

A prism for StatusDisabled.

_StatusDisabled ∷ Prism' StreamStatus ()

Stream Description

data StreamId Source

Identifier for a stream.

Length constraints: 56 ≤ n ≤ 128.

Instances

Eq StreamId
Ord StreamId
Read StreamId
Show StreamId
ToJSON StreamId
FromJSON StreamId
Typeable * StreamId
ListResponse ListStreamsResponse StreamId

data StreamDescription Source

Constructors

StreamDescription
Fields _sdCreationRequestDateTime :: !(Maybe UTCTime) _sdKeySchema :: ![KeySchemaElement] _sdLastEvaluatedShardId :: !(Maybe ShardId) _sdShards :: ![Shard] _sdStreamARN :: !(Maybe Text) _sdStreamId :: !(Maybe StreamId) _sdStreamStatus :: !(Maybe StreamStatus) _sdStreamViewType :: !(Maybe StreamViewType) _sdTableName :: !(Maybe Text)

Instances

Eq StreamDescription
Ord StreamDescription
Read StreamDescription
Show StreamDescription
ToJSON StreamDescription
FromJSON StreamDescription
Typeable * StreamDescription

Lenses

sdCreationRequestDateTime :: Functor f => (Maybe UTCTime -> f (Maybe UTCTime)) -> StreamDescription -> f StreamDescription Source

A lens for _sdCreationRequestDateTime.

sdCreationRequestDateTime ∷ Lens' StreamDescription (Maybe UTCTime)

sdKeySchema :: Functor f => ([KeySchemaElement] -> f [KeySchemaElement]) -> StreamDescription -> f StreamDescription Source

A lens for _sdKeySchema.

sdKeySchema ∷ Lens' StreamDescription [KeySchemaElement]

sdLastEvaluatedShardId :: Functor f => (Maybe ShardId -> f (Maybe ShardId)) -> StreamDescription -> f StreamDescription Source

A lens for _sdLastEvaluatedShardId.

sdLastEvaluatedShardId ∷ Lens' StreamDescription (Maybe ShardId)

sdShards :: Functor f => ([Shard] -> f [Shard]) -> StreamDescription -> f StreamDescription Source

A lens for _sdShards.

sdShards ∷ Lens' StreamDescription [Shard]

sdStreamARN :: Functor f => (Maybe Text -> f (Maybe Text)) -> StreamDescription -> f StreamDescription Source

A lens for _sdStreamARN.

sdStreamARN ∷ Lens' StreamDescription (Maybe Text)

sdStreamId :: Functor f => (Maybe StreamId -> f (Maybe StreamId)) -> StreamDescription -> f StreamDescription Source

A lens for _sdStreamId.

sdStreamId ∷ Lens' StreamDescription (Maybe StreamId)

sdStreamStatus :: Functor f => (Maybe StreamStatus -> f (Maybe StreamStatus)) -> StreamDescription -> f StreamDescription Source

A lens for _sdStreamStatus.

sdStreamStatus ∷ Lens' StreamDescription (Maybe StreamStatus)

sdStreamViewType :: Functor f => (Maybe StreamViewType -> f (Maybe StreamViewType)) -> StreamDescription -> f StreamDescription Source

A lens for _sdStreamViewType.

sdStreamViewType ∷ Lens' StreamDescription (Maybe StreamViewType)

sdTableName :: Functor f => (Maybe Text -> f (Maybe Text)) -> StreamDescription -> f StreamDescription Source

A lens for _sdTableName.

sdTableName ∷ Lens' StreamDescription (Maybe Text)

Enum ShardIteratorType
Eq ShardIteratorType
Ord ShardIteratorType
Read ShardIteratorType
Show ShardIteratorType
ToJSON ShardIteratorType
FromJSON ShardIteratorType
Typeable * ShardIteratorType

ShardIteratorTrimHorizon
ShardIteratorLatest
ShardIteratorAtSequenceNumber
ShardIteratorAfterSequenceNumber