amazonka-dynamodb-streams 1.4.3 → 1.4.4

raw patch · 9 files changed

+57/−56 lines, 9 filesdep ~amazonka-coredep ~amazonka-dynamodb-streamsdep ~amazonka-testPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

Dependency ranges changed: amazonka-core, amazonka-dynamodb-streams, amazonka-test

API changes (from Hackage documentation)

Files

• README.md +4/−10
• amazonka-dynamodb-streams.cabal +9/−15
• gen/Network/AWS/DynamoDBStreams.hs +4/−9
• gen/Network/AWS/DynamoDBStreams/DescribeStream.hs +1/−1
• gen/Network/AWS/DynamoDBStreams/GetRecords.hs +1/−1
• gen/Network/AWS/DynamoDBStreams/Types.hs +3/−0
• gen/Network/AWS/DynamoDBStreams/Types/Product.hs +30/−15
• gen/Network/AWS/DynamoDBStreams/Types/Sum.hs +5/−5
• src/.gitkeep +0/−0

@@ -8,22 +8,16 @@  ## Version -`1.4.3`+`1.4.4`   ## Description -Amazon DynamoDB Streams--This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html Amazon DynamoDB Developer Guide>.--Note that this document is intended for use with the following DynamoDB documentation:---   <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ Amazon DynamoDB Developer Guide>+Amazon DynamoDB --   <http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/ Amazon DynamoDB API Reference>+Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html Capturing Table Activity with DynamoDB Streams> in the Amazon DynamoDB Developer Guide. -The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.+The following are short descriptions of each low-level DynamoDB Streams action:  -   /DescribeStream/ - Returns detailed information about a particular stream. 

@@ -1,5 +1,5 @@ name:                  amazonka-dynamodb-streams-version:               1.4.3+version:               1.4.4 synopsis:              Amazon DynamoDB Streams SDK. homepage:              https://github.com/brendanhay/amazonka bug-reports:           https://github.com/brendanhay/amazonka/issues@@ -11,19 +11,13 @@ category:              Network, AWS, Cloud, Distributed Computing build-type:            Simple cabal-version:         >= 1.10-extra-source-files:    README.md fixture/*.yaml fixture/*.proto+extra-source-files:    README.md fixture/*.yaml fixture/*.proto src/.gitkeep description:-    Amazon DynamoDB Streams--    This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html Amazon DynamoDB Developer Guide>.--    Note that this document is intended for use with the following DynamoDB documentation:--    -   <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ Amazon DynamoDB Developer Guide>+    Amazon DynamoDB -    -   <http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/ Amazon DynamoDB API Reference>+    Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html Capturing Table Activity with DynamoDB Streams> in the Amazon DynamoDB Developer Guide. -    The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.+    The following are short descriptions of each low-level DynamoDB Streams action:      -   /DescribeStream/ - Returns detailed information about a particular stream. @@ -71,7 +65,7 @@         , Network.AWS.DynamoDBStreams.Types.Sum      build-depends:-          amazonka-core == 1.4.3.*+          amazonka-core == 1.4.4.*         , base          >= 4.7     && < 5  test-suite amazonka-dynamodb-streams-test@@ -91,9 +85,9 @@         , Test.AWS.DynamoDBStreams.Internal      build-depends:-          amazonka-core == 1.4.3.*-        , amazonka-test == 1.4.3.*-        , amazonka-dynamodb-streams == 1.4.3.*+          amazonka-core == 1.4.4.*+        , amazonka-test == 1.4.4.*+        , amazonka-dynamodb-streams == 1.4.4.*         , base         , bytestring         , tasty

@@ -11,17 +11,11 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Amazon DynamoDB Streams------ This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html Amazon DynamoDB Developer Guide>.------ Note that this document is intended for use with the following DynamoDB documentation:------ -   <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ Amazon DynamoDB Developer Guide>+-- Amazon DynamoDB ----- -   <http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/ Amazon DynamoDB API Reference>+-- Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html Capturing Table Activity with DynamoDB Streams> in the Amazon DynamoDB Developer Guide. ----- The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.+-- The following are short descriptions of each low-level DynamoDB Streams action: -- -- -   /DescribeStream/ - Returns detailed information about a particular stream. --@@ -157,6 +151,7 @@     , streamRecord     , srSizeBytes     , srSequenceNumber+    , srApproximateCreationDateTime     , srStreamViewType     , srKeys     , srOldImage

@@ -22,7 +22,7 @@ -- -- You can call /DescribeStream/ at a maximum rate of 10 times per second. ----- Each shard in the stream has a 'SequenceNumberRange' associated with it. If the 'SequenceNumberRange' has a 'StartingSequenceNumber' but no 'EndingSequenceNumber', then the shard is still open (able to receive more stream records). If both 'StartingSequenceNumber' and 'EndingSequenceNumber' are present, the that shared is closed and can no longer receive more data.+-- Each shard in the stream has a 'SequenceNumberRange' associated with it. If the 'SequenceNumberRange' has a 'StartingSequenceNumber' but no 'EndingSequenceNumber', then the shard is still open (able to receive more stream records). If both 'StartingSequenceNumber' and 'EndingSequenceNumber' are present, then that shard is closed and can no longer receive more data. module Network.AWS.DynamoDBStreams.DescribeStream     (     -- * Creating a Request

@@ -22,7 +22,7 @@ -- -- Specify a shard iterator using the 'ShardIterator' parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, 'GetRecords' returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. ----- GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first.+-- 'GetRecords' can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first. module Network.AWS.DynamoDBStreams.GetRecords     (     -- * Creating a Request

@@ -105,6 +105,7 @@     , streamRecord     , srSizeBytes     , srSequenceNumber+    , srApproximateCreationDateTime     , srStreamViewType     , srKeys     , srOldImage@@ -164,7 +165,9 @@ -- 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. You might receive a TrimmedDataAccessException if: -- -- -   You request a shard iterator with a sequence number older than the trim point (24 hours).+-- -- -   You obtain a shard iterator, but before you use the iterator in a /GetRecords/ request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.+-- _TrimmedDataAccessException :: AsError a => Getting (First ServiceError) a ServiceError _TrimmedDataAccessException =     _ServiceError . hasCode "TrimmedDataAccessException"

@@ -145,8 +145,12 @@  -- | Represents /a single element/ of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. ----- A /KeySchemaElement/ represents exactly one attribute of the primary key. For example, a hash type primary key would be represented by one /KeySchemaElement/. A hash-and-range type primary key would require one /KeySchemaElement/ for the hash attribute, and another /KeySchemaElement/ for the range attribute.+-- A /KeySchemaElement/ represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one /KeySchemaElement/. A composite primary key (partition key and sort key) would require one /KeySchemaElement/ for the partition key, and another /KeySchemaElement/ for the sort key. --+-- The partition key of an item is also known as its /hash attribute/. The term \"hash attribute\" derives from DynamoDB\'s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.+--+-- The sort key of an item is also known as its /range attribute/. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.+-- -- /See:/ 'keySchemaElement' smart constructor. data KeySchemaElement = KeySchemaElement'     { _kseAttributeName :: !Text@@ -228,7 +232,9 @@     , _rEventId = Nothing     } --- | The version number of the stream record format. Currently, this is /1.0/.+-- | The version number of the stream record format. This number is updated whenever the structure of /Record/ is modified.+--+-- Client applications must not assume that /eventVersion/ will remain at a particular value, as this number is subject to change at any time. In general, /eventVersion/ will only increase as the low-level DynamoDB Streams API evolves. rEventVersion :: Lens' Record (Maybe Text) rEventVersion = lens _rEventVersion (\ s a -> s{_rEventVersion = a}); @@ -244,7 +250,7 @@ -- -- -   'INSERT' - a new item was added to the table. ----- -   'MODIFY' - one or more of the item\'s attributes were updated.+-- -   'MODIFY' - one or more of an existing item\'s attributes were modified. -- -- -   'REMOVE' - the item was deleted from the table --@@ -505,7 +511,7 @@ -- -- -   'ENABLING' - Streams is currently being enabled on the DynamoDB table. ----- -   'ENABLING' - the stream is enabled.+-- -   'ENABLED' - the stream is enabled. -- -- -   'DISABLING' - Streams is currently being disabled on the DynamoDB table. --@@ -522,9 +528,9 @@ -- -- -   'KEYS_ONLY' - only the key attributes of items that were modified in the DynamoDB table. ----- -   'NEW_IMAGE' - entire item from the table, as it appeared after they were modified.+-- -   'NEW_IMAGE' - entire items from the table, as they appeared after they were modified. ----- -   'OLD_IMAGE' - entire item from the table, as it appeared before they were modified.+-- -   'OLD_IMAGE' - entire items from the table, as they appeared before they were modified. -- -- -   'NEW_AND_OLD_IMAGES' - both the new and the old images of the items from the table. --@@ -570,12 +576,13 @@ -- -- /See:/ 'streamRecord' smart constructor. data StreamRecord = StreamRecord'-    { _srSizeBytes      :: !(Maybe Nat)-    , _srSequenceNumber :: !(Maybe Text)-    , _srStreamViewType :: !(Maybe StreamViewType)-    , _srKeys           :: !(Maybe (Map Text AttributeValue))-    , _srOldImage       :: !(Maybe (Map Text AttributeValue))-    , _srNewImage       :: !(Maybe (Map Text AttributeValue))+    { _srSizeBytes                   :: !(Maybe Nat)+    , _srSequenceNumber              :: !(Maybe Text)+    , _srApproximateCreationDateTime :: !(Maybe POSIX)+    , _srStreamViewType              :: !(Maybe StreamViewType)+    , _srKeys                        :: !(Maybe (Map Text AttributeValue))+    , _srOldImage                    :: !(Maybe (Map Text AttributeValue))+    , _srNewImage                    :: !(Maybe (Map Text AttributeValue))     } deriving (Eq,Read,Show,Data,Typeable,Generic)  -- | Creates a value of 'StreamRecord' with the minimum fields required to make a request.@@ -586,6 +593,8 @@ -- -- * 'srSequenceNumber' --+-- * 'srApproximateCreationDateTime'+-- -- * 'srStreamViewType' -- -- * 'srKeys'@@ -599,6 +608,7 @@     StreamRecord'     { _srSizeBytes = Nothing     , _srSequenceNumber = Nothing+    , _srApproximateCreationDateTime = Nothing     , _srStreamViewType = Nothing     , _srKeys = Nothing     , _srOldImage = Nothing@@ -613,15 +623,19 @@ srSequenceNumber :: Lens' StreamRecord (Maybe Text) srSequenceNumber = lens _srSequenceNumber (\ s a -> s{_srSequenceNumber = a}); +-- | The approximate date and time when the stream record was created, in <http://www.epochconverter.com/ UNIX epoch time> format.+srApproximateCreationDateTime :: Lens' StreamRecord (Maybe UTCTime)+srApproximateCreationDateTime = lens _srApproximateCreationDateTime (\ s a -> s{_srApproximateCreationDateTime = a}) . mapping _Time;+ -- | The type of data from the modified DynamoDB item that was captured in this stream record: -- -- -   'KEYS_ONLY' - only the key attributes of the modified item. ----- -   'NEW_IMAGE' - the entire item, as it appears after it was modified.+-- -   'NEW_IMAGE' - the entire item, as it appeared after it was modified. -- -- -   'OLD_IMAGE' - the entire item, as it appeared before it was modified. ----- -   'NEW_AND_OLD_IMAGES' — both the new and the old item images of the item.+-- -   'NEW_AND_OLD_IMAGES' - both the new and the old item images of the item. -- srStreamViewType :: Lens' StreamRecord (Maybe StreamViewType) srStreamViewType = lens _srStreamViewType (\ s a -> s{_srStreamViewType = a});@@ -644,7 +658,8 @@               (\ x ->                  StreamRecord' <$>                    (x .:? "SizeBytes") <*> (x .:? "SequenceNumber") <*>-                     (x .:? "StreamViewType")+                     (x .:? "ApproximateCreationDateTime")+                     <*> (x .:? "StreamViewType")                      <*> (x .:? "Keys" .!= mempty)                      <*> (x .:? "OldImage" .!= mempty)                      <*> (x .:? "NewImage" .!= mempty))

@@ -29,7 +29,7 @@         "hash" -> pure Hash         "range" -> pure Range         e -> fromTextError $ "Failure parsing KeyType from value: '" <> e-           <> "'. Accepted values: HASH, RANGE"+           <> "'. Accepted values: hash, range"  instance ToText KeyType where     toText = \case@@ -57,7 +57,7 @@         "modify" -> pure Modify         "remove" -> pure Remove         e -> fromTextError $ "Failure parsing OperationType from value: '" <> e-           <> "'. Accepted values: INSERT, MODIFY, REMOVE"+           <> "'. Accepted values: insert, modify, remove"  instance ToText OperationType where     toText = \case@@ -88,7 +88,7 @@         "latest" -> pure Latest         "trim_horizon" -> pure TrimHorizon         e -> fromTextError $ "Failure parsing ShardIteratorType from value: '" <> e-           <> "'. Accepted values: AFTER_SEQUENCE_NUMBER, AT_SEQUENCE_NUMBER, LATEST, TRIM_HORIZON"+           <> "'. Accepted values: after_sequence_number, at_sequence_number, latest, trim_horizon"  instance ToText ShardIteratorType where     toText = \case@@ -120,7 +120,7 @@         "enabled" -> pure Enabled         "enabling" -> pure Enabling         e -> fromTextError $ "Failure parsing StreamStatus from value: '" <> e-           <> "'. Accepted values: DISABLED, DISABLING, ENABLED, ENABLING"+           <> "'. Accepted values: disabled, disabling, enabled, enabling"  instance ToText StreamStatus where     toText = \case@@ -152,7 +152,7 @@         "new_image" -> pure NewImage         "old_image" -> pure OldImage         e -> fromTextError $ "Failure parsing StreamViewType from value: '" <> e-           <> "'. Accepted values: KEYS_ONLY, NEW_AND_OLD_IMAGES, NEW_IMAGE, OLD_IMAGE"+           <> "'. Accepted values: keys_only, new_and_old_images, new_image, old_image"  instance ToText StreamViewType where     toText = \case