summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrendanHay <>2016-12-04 15:31:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2016-12-04 15:31:00 (GMT)
commit06a55eb2c96306e176889983748e552145733a3c (patch)
tree611489c60e6d47d27cf98864c7838a69e5a8f9f5
parent6105d4e3628eb9a0269ad55c601cad79cbf7463f (diff)
version 1.4.51.4.5
-rw-r--r--README.md17
-rw-r--r--amazonka-kinesis.cabal25
-rw-r--r--fixture/DescribeLimits.yaml0
-rw-r--r--fixture/DescribeLimitsResponse.proto0
-rw-r--r--fixture/UpdateShardCount.yaml0
-rw-r--r--fixture/UpdateShardCountResponse.proto0
-rw-r--r--gen/Network/AWS/Kinesis.hs15
-rw-r--r--gen/Network/AWS/Kinesis/AddTagsToStream.hs12
-rw-r--r--gen/Network/AWS/Kinesis/CreateStream.hs33
-rw-r--r--gen/Network/AWS/Kinesis/DecreaseStreamRetentionPeriod.hs14
-rw-r--r--gen/Network/AWS/Kinesis/DeleteStream.hs18
-rw-r--r--gen/Network/AWS/Kinesis/DescribeLimits.hs133
-rw-r--r--gen/Network/AWS/Kinesis/DescribeStream.hs34
-rw-r--r--gen/Network/AWS/Kinesis/DisableEnhancedMonitoring.hs25
-rw-r--r--gen/Network/AWS/Kinesis/EnableEnhancedMonitoring.hs25
-rw-r--r--gen/Network/AWS/Kinesis/GetRecords.hs44
-rw-r--r--gen/Network/AWS/Kinesis/GetShardIterator.hs48
-rw-r--r--gen/Network/AWS/Kinesis/IncreaseStreamRetentionPeriod.hs14
-rw-r--r--gen/Network/AWS/Kinesis/ListStreams.hs32
-rw-r--r--gen/Network/AWS/Kinesis/ListTagsForStream.hs32
-rw-r--r--gen/Network/AWS/Kinesis/MergeShards.hs28
-rw-r--r--gen/Network/AWS/Kinesis/PutRecord.hs50
-rw-r--r--gen/Network/AWS/Kinesis/PutRecords.hs48
-rw-r--r--gen/Network/AWS/Kinesis/RemoveTagsFromStream.hs10
-rw-r--r--gen/Network/AWS/Kinesis/SplitShard.hs34
-rw-r--r--gen/Network/AWS/Kinesis/Types.hs26
-rw-r--r--gen/Network/AWS/Kinesis/Types/Product.hs174
-rw-r--r--gen/Network/AWS/Kinesis/Types/Sum.hs23
-rw-r--r--gen/Network/AWS/Kinesis/UpdateShardCount.hs183
-rw-r--r--gen/Network/AWS/Kinesis/Waiters.hs6
-rw-r--r--test/Test/AWS/Gen/Kinesis.hs36
31 files changed, 791 insertions, 348 deletions
diff --git a/README.md b/README.md
index c40ad7b..fc71636 100644
--- a/README.md
+++ b/README.md
@@ -8,27 +8,28 @@
## Version
-`1.4.4`
+`1.4.5`
## Description
-Amazon Kinesis Streams Service API Reference
-
-Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.
-
Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-kinesis)
and the [AWS API Reference](https://aws.amazon.com/documentation/).
The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),
-which provides mechanisms for specifying AuthN/AuthZ information and sending requests.
+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,
+and receiving responses.
-Use of lenses is required for constructing and manipulating types.
-This is due to the amount of nesting of AWS types and transparency regarding
+Lenses are used for constructing and manipulating types,
+due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
[lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).
+See [Network.AWS.Kinesis](http://hackage.haskell.org/package/amazonka-kinesis/docs/Network-AWS-Kinesis.html)
+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.
+
+
## Contribute
For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues).
diff --git a/amazonka-kinesis.cabal b/amazonka-kinesis.cabal
index e3ca1bf..67998a2 100644
--- a/amazonka-kinesis.cabal
+++ b/amazonka-kinesis.cabal
@@ -1,5 +1,5 @@
name: amazonka-kinesis
-version: 1.4.4
+version: 1.4.5
synopsis: Amazon Kinesis SDK.
homepage: https://github.com/brendanhay/amazonka
bug-reports: https://github.com/brendanhay/amazonka/issues
@@ -13,22 +13,19 @@ build-type: Simple
cabal-version: >= 1.10
extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep
description:
- Amazon Kinesis Streams Service API Reference
-
- Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.
- .
The types from this library are intended to be used with
<http://hackage.haskell.org/package/amazonka amazonka>, which provides
- mechanisms for specifying AuthN/AuthZ information and sending requests.
+ mechanisms for specifying AuthN/AuthZ information, sending requests,
+ and receiving responses.
.
- Use of lenses is required for constructing and manipulating types.
- This is due to the amount of nesting of AWS types and transparency regarding
+ Lenses are used for constructing and manipulating types,
+ due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
such as <http://hackage.haskell.org/package/lens lens> or
<http://hackage.haskell.org/package/lens-family-core lens-family-core>.
.
- See "Network.AWS.Kinesis" or <https://aws.amazon.com/documentation/ the AWS Documentation>
+ See "Network.AWS.Kinesis" or <https://aws.amazon.com/documentation/ the AWS documentation>
to get started.
source-repository head
@@ -47,6 +44,7 @@ library
, Network.AWS.Kinesis.CreateStream
, Network.AWS.Kinesis.DecreaseStreamRetentionPeriod
, Network.AWS.Kinesis.DeleteStream
+ , Network.AWS.Kinesis.DescribeLimits
, Network.AWS.Kinesis.DescribeStream
, Network.AWS.Kinesis.DisableEnhancedMonitoring
, Network.AWS.Kinesis.EnableEnhancedMonitoring
@@ -61,6 +59,7 @@ library
, Network.AWS.Kinesis.RemoveTagsFromStream
, Network.AWS.Kinesis.SplitShard
, Network.AWS.Kinesis.Types
+ , Network.AWS.Kinesis.UpdateShardCount
, Network.AWS.Kinesis.Waiters
other-modules:
@@ -68,7 +67,7 @@ library
, Network.AWS.Kinesis.Types.Sum
build-depends:
- amazonka-core == 1.4.4.*
+ amazonka-core == 1.4.5.*
, base >= 4.7 && < 5
test-suite amazonka-kinesis-test
@@ -88,9 +87,9 @@ test-suite amazonka-kinesis-test
, Test.AWS.Kinesis.Internal
build-depends:
- amazonka-core == 1.4.4.*
- , amazonka-test == 1.4.4.*
- , amazonka-kinesis == 1.4.4.*
+ amazonka-core == 1.4.5.*
+ , amazonka-test == 1.4.5.*
+ , amazonka-kinesis == 1.4.5.*
, base
, bytestring
, tasty
diff --git a/fixture/DescribeLimits.yaml b/fixture/DescribeLimits.yaml
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/fixture/DescribeLimits.yaml
diff --git a/fixture/DescribeLimitsResponse.proto b/fixture/DescribeLimitsResponse.proto
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/fixture/DescribeLimitsResponse.proto
diff --git a/fixture/UpdateShardCount.yaml b/fixture/UpdateShardCount.yaml
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/fixture/UpdateShardCount.yaml
diff --git a/fixture/UpdateShardCountResponse.proto b/fixture/UpdateShardCountResponse.proto
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/fixture/UpdateShardCountResponse.proto
diff --git a/gen/Network/AWS/Kinesis.hs b/gen/Network/AWS/Kinesis.hs
index d303c9b..c91dedd 100644
--- a/gen/Network/AWS/Kinesis.hs
+++ b/gen/Network/AWS/Kinesis.hs
@@ -11,9 +11,10 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Amazon Kinesis Streams Service API Reference
+-- __Amazon Kinesis Streams Service API Reference__
--
-- Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.
+--
module Network.AWS.Kinesis
(
-- * Service Configuration
@@ -70,9 +71,15 @@ module Network.AWS.Kinesis
-- ** EnableEnhancedMonitoring
, module Network.AWS.Kinesis.EnableEnhancedMonitoring
+ -- ** DescribeLimits
+ , module Network.AWS.Kinesis.DescribeLimits
+
-- ** DisableEnhancedMonitoring
, module Network.AWS.Kinesis.DisableEnhancedMonitoring
+ -- ** UpdateShardCount
+ , module Network.AWS.Kinesis.UpdateShardCount
+
-- ** ListTagsForStream
, module Network.AWS.Kinesis.ListTagsForStream
@@ -108,6 +115,9 @@ module Network.AWS.Kinesis
-- ** MetricsName
, MetricsName (..)
+ -- ** ScalingType
+ , ScalingType (..)
+
-- ** ShardIteratorType
, ShardIteratorType (..)
@@ -179,6 +189,7 @@ module Network.AWS.Kinesis
, sdShards
, sdHasMoreShards
, sdRetentionPeriodHours
+ , sdStreamCreationTimestamp
, sdEnhancedMonitoring
-- ** Tag
@@ -192,6 +203,7 @@ import Network.AWS.Kinesis.AddTagsToStream
import Network.AWS.Kinesis.CreateStream
import Network.AWS.Kinesis.DecreaseStreamRetentionPeriod
import Network.AWS.Kinesis.DeleteStream
+import Network.AWS.Kinesis.DescribeLimits
import Network.AWS.Kinesis.DescribeStream
import Network.AWS.Kinesis.DisableEnhancedMonitoring
import Network.AWS.Kinesis.EnableEnhancedMonitoring
@@ -206,6 +218,7 @@ import Network.AWS.Kinesis.PutRecords
import Network.AWS.Kinesis.RemoveTagsFromStream
import Network.AWS.Kinesis.SplitShard
import Network.AWS.Kinesis.Types
+import Network.AWS.Kinesis.UpdateShardCount
import Network.AWS.Kinesis.Waiters
{- $errors
diff --git a/gen/Network/AWS/Kinesis/AddTagsToStream.hs b/gen/Network/AWS/Kinesis/AddTagsToStream.hs
index 340149d..9838063 100644
--- a/gen/Network/AWS/Kinesis/AddTagsToStream.hs
+++ b/gen/Network/AWS/Kinesis/AddTagsToStream.hs
@@ -20,7 +20,9 @@
--
-- Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.
--
--- If tags have already been assigned to the stream, 'AddTagsToStream' overwrites any existing tags that correspond to the specified tag keys.
+--
+-- If tags have already been assigned to the stream, @AddTagsToStream@ overwrites any existing tags that correspond to the specified tag keys.
+--
module Network.AWS.Kinesis.AddTagsToStream
(
-- * Creating a Request
@@ -42,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'AddTagsToStream'.
+-- | Represents the input for @AddTagsToStream@ .
+--
+--
--
-- /See:/ 'addTagsToStream' smart constructor.
data AddTagsToStream = AddTagsToStream'
@@ -54,9 +58,9 @@ data AddTagsToStream = AddTagsToStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'attsStreamName'
+-- * 'attsStreamName' - The name of the stream.
--
--- * 'attsTags'
+-- * 'attsTags' - The set of key-value pairs to use to create the tags.
addTagsToStream
:: Text -- ^ 'attsStreamName'
-> AddTagsToStream
diff --git a/gen/Network/AWS/Kinesis/CreateStream.hs b/gen/Network/AWS/Kinesis/CreateStream.hs
index 65ddc85..f8c1e80 100644
--- a/gen/Network/AWS/Kinesis/CreateStream.hs
+++ b/gen/Network/AWS/Kinesis/CreateStream.hs
@@ -18,24 +18,29 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or /producers/. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
+-- Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or /producers/ . Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
+--
--
-- You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.
--
-- The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.
--
--- 'CreateStream' is an asynchronous operation. Upon receiving a 'CreateStream' request, Amazon Kinesis immediately returns and sets the stream status to 'CREATING'. After the stream is created, Amazon Kinesis sets the stream status to 'ACTIVE'. You should perform read and write operations only on an 'ACTIVE' stream.
+-- @CreateStream@ is an asynchronous operation. Upon receiving a @CreateStream@ request, Amazon Kinesis immediately returns and sets the stream status to @CREATING@ . After the stream is created, Amazon Kinesis sets the stream status to @ACTIVE@ . You should perform read and write operations only on an @ACTIVE@ stream.
+--
+-- You receive a @LimitExceededException@ when making a @CreateStream@ request if you try to do one of the following:
+--
+-- * Have more than five streams in the @CREATING@ state at any point in time.
+--
+-- * Create more shards than are authorized for your account.
--
--- You receive a 'LimitExceededException' when making a 'CreateStream' request if you try to do one of the following:
--
--- - Have more than five streams in the 'CREATING' state at any point in time.
--- - Create more shards than are authorized for your account.
--
--- For the default shard limit for an AWS account, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/. If you need to increase this limit, <http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html contact AWS Support>.
+-- For the default shard limit for an AWS account, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ . If you need to increase this limit, <http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html contact AWS Support> .
--
--- You can use 'DescribeStream' to check the stream status, which is returned in 'StreamStatus'.
+-- You can use @DescribeStream@ to check the stream status, which is returned in @StreamStatus@ .
+--
+-- 'CreateStream' has a limit of 5 transactions per second per account.
--
--- < CreateStream> has a limit of 5 transactions per second per account.
module Network.AWS.Kinesis.CreateStream
(
-- * Creating a Request
@@ -57,7 +62,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'CreateStream'.
+-- | Represents the input for @CreateStream@ .
+--
+--
--
-- /See:/ 'createStream' smart constructor.
data CreateStream = CreateStream'
@@ -69,9 +76,9 @@ data CreateStream = CreateStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'csStreamName'
+-- * 'csStreamName' - A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account but in two different regions can have the same name.
--
--- * 'csShardCount'
+-- * 'csShardCount' - The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput. DefaultShardLimit;
createStream
:: Text -- ^ 'csStreamName'
-> Natural -- ^ 'csShardCount'
@@ -86,9 +93,7 @@ createStream pStreamName_ pShardCount_ =
csStreamName :: Lens' CreateStream Text
csStreamName = lens _csStreamName (\ s a -> s{_csStreamName = a});
--- | The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
---
--- DefaultShardLimit;
+-- | The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput. DefaultShardLimit;
csShardCount :: Lens' CreateStream Natural
csShardCount = lens _csShardCount (\ s a -> s{_csShardCount = a}) . _Nat;
diff --git a/gen/Network/AWS/Kinesis/DecreaseStreamRetentionPeriod.hs b/gen/Network/AWS/Kinesis/DecreaseStreamRetentionPeriod.hs
index 79a5dca..d0a1fa2 100644
--- a/gen/Network/AWS/Kinesis/DecreaseStreamRetentionPeriod.hs
+++ b/gen/Network/AWS/Kinesis/DecreaseStreamRetentionPeriod.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Decreases the Amazon Kinesis stream\'s retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream\'s retention period is 24 hours.
+-- Decreases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.
+--
+--
+-- This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.
--
--- This operation may result in lost data. For example, if the stream\'s retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.
module Network.AWS.Kinesis.DecreaseStreamRetentionPeriod
(
-- * Creating a Request
@@ -42,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < DecreaseStreamRetentionPeriod>.
+-- | Represents the input for 'DecreaseStreamRetentionPeriod' .
+--
+--
--
-- /See:/ 'decreaseStreamRetentionPeriod' smart constructor.
data DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriod'
@@ -54,9 +58,9 @@ data DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriod'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dsrpStreamName'
+-- * 'dsrpStreamName' - The name of the stream to modify.
--
--- * 'dsrpRetentionPeriodHours'
+-- * 'dsrpRetentionPeriodHours' - The new retention period of the stream, in hours. Must be less than the current retention period.
decreaseStreamRetentionPeriod
:: Text -- ^ 'dsrpStreamName'
-> Natural -- ^ 'dsrpRetentionPeriodHours'
diff --git a/gen/Network/AWS/Kinesis/DeleteStream.hs b/gen/Network/AWS/Kinesis/DeleteStream.hs
index e650f92..7c940a8 100644
--- a/gen/Network/AWS/Kinesis/DeleteStream.hs
+++ b/gen/Network/AWS/Kinesis/DeleteStream.hs
@@ -18,17 +18,19 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Deletes an Amazon Kinesis stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception 'ResourceNotFoundException'.
+-- Deletes an Amazon Kinesis stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception @ResourceNotFoundException@ .
--
--- If the stream is in the 'ACTIVE' state, you can delete it. After a 'DeleteStream' request, the specified stream is in the 'DELETING' state until Amazon Kinesis completes the deletion.
--
--- __Note:__ Amazon Kinesis might continue to accept data read and write operations, such as < PutRecord>, < PutRecords>, and < GetRecords>, on a stream in the 'DELETING' state until the stream deletion is complete.
+-- If the stream is in the @ACTIVE@ state, you can delete it. After a @DeleteStream@ request, the specified stream is in the @DELETING@ state until Amazon Kinesis completes the deletion.
+--
+-- __Note:__ Amazon Kinesis might continue to accept data read and write operations, such as 'PutRecord' , 'PutRecords' , and 'GetRecords' , on a stream in the @DELETING@ state until the stream deletion is complete.
--
-- When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
--
--- You can use the < DescribeStream> operation to check the state of the stream, which is returned in 'StreamStatus'.
+-- You can use the 'DescribeStream' operation to check the state of the stream, which is returned in @StreamStatus@ .
+--
+-- 'DeleteStream' has a limit of 5 transactions per second per account.
--
--- < DeleteStream> has a limit of 5 transactions per second per account.
module Network.AWS.Kinesis.DeleteStream
(
-- * Creating a Request
@@ -49,7 +51,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < DeleteStream>.
+-- | Represents the input for 'DeleteStream' .
+--
+--
--
-- /See:/ 'deleteStream' smart constructor.
newtype DeleteStream = DeleteStream'
@@ -60,7 +64,7 @@ newtype DeleteStream = DeleteStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dsStreamName'
+-- * 'dsStreamName' - The name of the stream to delete.
deleteStream
:: Text -- ^ 'dsStreamName'
-> DeleteStream
diff --git a/gen/Network/AWS/Kinesis/DescribeLimits.hs b/gen/Network/AWS/Kinesis/DescribeLimits.hs
new file mode 100644
index 0000000..cdf59ef
--- /dev/null
+++ b/gen/Network/AWS/Kinesis/DescribeLimits.hs
@@ -0,0 +1,133 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE TypeFamilies #-}
+
+{-# OPTIONS_GHC -fno-warn-unused-imports #-}
+{-# OPTIONS_GHC -fno-warn-unused-binds #-}
+{-# OPTIONS_GHC -fno-warn-unused-matches #-}
+
+-- Derived from AWS service descriptions, licensed under Apache 2.0.
+
+-- |
+-- Module : Network.AWS.Kinesis.DescribeLimits
+-- Copyright : (c) 2013-2016 Brendan Hay
+-- License : Mozilla Public License, v. 2.0.
+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>
+-- Stability : auto-generated
+-- Portability : non-portable (GHC extensions)
+--
+-- Describes the shard limits and usage for the account.
+--
+--
+-- If you update your account limits, the old limits might be returned for a few minutes.
+--
+-- This operation has a limit of 1 transaction per second per account.
+--
+module Network.AWS.Kinesis.DescribeLimits
+ (
+ -- * Creating a Request
+ describeLimits
+ , DescribeLimits
+
+ -- * Destructuring the Response
+ , describeLimitsResponse
+ , DescribeLimitsResponse
+ -- * Response Lenses
+ , dlrsResponseStatus
+ , dlrsShardLimit
+ , dlrsOpenShardCount
+ ) where
+
+import Network.AWS.Kinesis.Types
+import Network.AWS.Kinesis.Types.Product
+import Network.AWS.Lens
+import Network.AWS.Prelude
+import Network.AWS.Request
+import Network.AWS.Response
+
+-- | /See:/ 'describeLimits' smart constructor.
+data DescribeLimits =
+ DescribeLimits'
+ deriving (Eq,Read,Show,Data,Typeable,Generic)
+
+-- | Creates a value of 'DescribeLimits' with the minimum fields required to make a request.
+--
+describeLimits
+ :: DescribeLimits
+describeLimits = DescribeLimits'
+
+instance AWSRequest DescribeLimits where
+ type Rs DescribeLimits = DescribeLimitsResponse
+ request = postJSON kinesis
+ response
+ = receiveJSON
+ (\ s h x ->
+ DescribeLimitsResponse' <$>
+ (pure (fromEnum s)) <*> (x .:> "ShardLimit") <*>
+ (x .:> "OpenShardCount"))
+
+instance Hashable DescribeLimits
+
+instance NFData DescribeLimits
+
+instance ToHeaders DescribeLimits where
+ toHeaders
+ = const
+ (mconcat
+ ["X-Amz-Target" =#
+ ("Kinesis_20131202.DescribeLimits" :: ByteString),
+ "Content-Type" =#
+ ("application/x-amz-json-1.1" :: ByteString)])
+
+instance ToJSON DescribeLimits where
+ toJSON = const (Object mempty)
+
+instance ToPath DescribeLimits where
+ toPath = const "/"
+
+instance ToQuery DescribeLimits where
+ toQuery = const mempty
+
+-- | /See:/ 'describeLimitsResponse' smart constructor.
+data DescribeLimitsResponse = DescribeLimitsResponse'
+ { _dlrsResponseStatus :: !Int
+ , _dlrsShardLimit :: !Nat
+ , _dlrsOpenShardCount :: !Nat
+ } deriving (Eq,Read,Show,Data,Typeable,Generic)
+
+-- | Creates a value of 'DescribeLimitsResponse' with the minimum fields required to make a request.
+--
+-- Use one of the following lenses to modify other fields as desired:
+--
+-- * 'dlrsResponseStatus' - -- | The response status code.
+--
+-- * 'dlrsShardLimit' - The maximum number of shards.
+--
+-- * 'dlrsOpenShardCount' - The number of open shards.
+describeLimitsResponse
+ :: Int -- ^ 'dlrsResponseStatus'
+ -> Natural -- ^ 'dlrsShardLimit'
+ -> Natural -- ^ 'dlrsOpenShardCount'
+ -> DescribeLimitsResponse
+describeLimitsResponse pResponseStatus_ pShardLimit_ pOpenShardCount_ =
+ DescribeLimitsResponse'
+ { _dlrsResponseStatus = pResponseStatus_
+ , _dlrsShardLimit = _Nat # pShardLimit_
+ , _dlrsOpenShardCount = _Nat # pOpenShardCount_
+ }
+
+-- | -- | The response status code.
+dlrsResponseStatus :: Lens' DescribeLimitsResponse Int
+dlrsResponseStatus = lens _dlrsResponseStatus (\ s a -> s{_dlrsResponseStatus = a});
+
+-- | The maximum number of shards.
+dlrsShardLimit :: Lens' DescribeLimitsResponse Natural
+dlrsShardLimit = lens _dlrsShardLimit (\ s a -> s{_dlrsShardLimit = a}) . _Nat;
+
+-- | The number of open shards.
+dlrsOpenShardCount :: Lens' DescribeLimitsResponse Natural
+dlrsOpenShardCount = lens _dlrsOpenShardCount (\ s a -> s{_dlrsOpenShardCount = a}) . _Nat;
+
+instance NFData DescribeLimitsResponse
diff --git a/gen/Network/AWS/Kinesis/DescribeStream.hs b/gen/Network/AWS/Kinesis/DescribeStream.hs
index 64d049e..03819d1 100644
--- a/gen/Network/AWS/Kinesis/DescribeStream.hs
+++ b/gen/Network/AWS/Kinesis/DescribeStream.hs
@@ -20,15 +20,15 @@
--
-- Describes the specified Amazon Kinesis stream.
--
--- The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the stream. The sequence number is assigned when a record is put into the stream.
--
--- You can limit the number of returned shards using the 'Limit' parameter. The number of shards in a stream may be too large to return from a single call to 'DescribeStream'. You can detect this by using the 'HasMoreShards' flag in the returned output. 'HasMoreShards' is set to 'true' when there is more data available.
+-- The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
--
--- 'DescribeStream' is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the 'ExclusiveStartShardId' parameter in a subsequent request to 'DescribeStream'.
+-- You can limit the number of shards returned by each call. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html Retrieving Shards from a Stream> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- There are no guarantees about the chronological order shards returned in 'DescribeStream' results. If you want to process shards in chronological order, use 'ParentShardId' to track lineage to the oldest shard.
+-- There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
+--
+-- This operation has a limit of 10 transactions per second per account.
--
--- < DescribeStream> has a limit of 10 transactions per second per account.
--
-- This operation returns paginated results.
module Network.AWS.Kinesis.DescribeStream
@@ -57,7 +57,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'DescribeStream'.
+-- | Represents the input for @DescribeStream@ .
+--
+--
--
-- /See:/ 'describeStream' smart constructor.
data DescribeStream = DescribeStream'
@@ -70,11 +72,11 @@ data DescribeStream = DescribeStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dExclusiveStartShardId'
+-- * 'dExclusiveStartShardId' - The shard ID of the shard to start with.
--
--- * 'dLimit'
+-- * 'dLimit' - The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.
--
--- * 'dStreamName'
+-- * 'dStreamName' - The name of the stream to describe.
describeStream
:: Text -- ^ 'dStreamName'
-> DescribeStream
@@ -89,7 +91,7 @@ describeStream pStreamName_ =
dExclusiveStartShardId :: Lens' DescribeStream (Maybe Text)
dExclusiveStartShardId = lens _dExclusiveStartShardId (\ s a -> s{_dExclusiveStartShardId = a});
--- | The maximum number of shards to return.
+-- | The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.
dLimit :: Lens' DescribeStream (Maybe Natural)
dLimit = lens _dLimit (\ s a -> s{_dLimit = a}) . mapping _Nat;
@@ -149,7 +151,9 @@ instance ToPath DescribeStream where
instance ToQuery DescribeStream where
toQuery = const mempty
--- | Represents the output for 'DescribeStream'.
+-- | Represents the output for @DescribeStream@ .
+--
+--
--
-- /See:/ 'describeStreamResponse' smart constructor.
data DescribeStreamResponse = DescribeStreamResponse'
@@ -161,9 +165,9 @@ data DescribeStreamResponse = DescribeStreamResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dsrsResponseStatus'
+-- * 'dsrsResponseStatus' - -- | The response status code.
--
--- * 'dsrsStreamDescription'
+-- * 'dsrsStreamDescription' - The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.
describeStreamResponse
:: Int -- ^ 'dsrsResponseStatus'
-> StreamDescription -- ^ 'dsrsStreamDescription'
@@ -174,11 +178,11 @@ describeStreamResponse pResponseStatus_ pStreamDescription_ =
, _dsrsStreamDescription = pStreamDescription_
}
--- | The response status code.
+-- | -- | The response status code.
dsrsResponseStatus :: Lens' DescribeStreamResponse Int
dsrsResponseStatus = lens _dsrsResponseStatus (\ s a -> s{_dsrsResponseStatus = a});
--- | The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.
+-- | The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.
dsrsStreamDescription :: Lens' DescribeStreamResponse StreamDescription
dsrsStreamDescription = lens _dsrsStreamDescription (\ s a -> s{_dsrsStreamDescription = a});
diff --git a/gen/Network/AWS/Kinesis/DisableEnhancedMonitoring.hs b/gen/Network/AWS/Kinesis/DisableEnhancedMonitoring.hs
index 2c01d0a..5a38a9d 100644
--- a/gen/Network/AWS/Kinesis/DisableEnhancedMonitoring.hs
+++ b/gen/Network/AWS/Kinesis/DisableEnhancedMonitoring.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Disables enhanced monitoring.
+--
+--
module Network.AWS.Kinesis.DisableEnhancedMonitoring
(
-- * Creating a Request
@@ -44,7 +46,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < DisableEnhancedMonitoring>.
+-- | Represents the input for 'DisableEnhancedMonitoring' .
+--
+--
--
-- /See:/ 'disableEnhancedMonitoring' smart constructor.
data DisableEnhancedMonitoring = DisableEnhancedMonitoring'
@@ -56,9 +60,9 @@ data DisableEnhancedMonitoring = DisableEnhancedMonitoring'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'demStreamName'
+-- * 'demStreamName' - The name of the Amazon Kinesis stream for which to disable enhanced monitoring.
--
--- * 'demShardLevelMetrics'
+-- * 'demShardLevelMetrics' - List of shard-level metrics to disable. The following are the valid shard-level metrics. The value "@ALL@ " disables every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
disableEnhancedMonitoring
:: Text -- ^ 'demStreamName'
-> DisableEnhancedMonitoring
@@ -72,20 +76,7 @@ disableEnhancedMonitoring pStreamName_ =
demStreamName :: Lens' DisableEnhancedMonitoring Text
demStreamName = lens _demStreamName (\ s a -> s{_demStreamName = a});
--- | List of shard-level metrics to disable.
---
--- The following are the valid shard-level metrics. The value \"'ALL'\" disables every metric.
---
--- - 'IncomingBytes'
--- - 'IncomingRecords'
--- - 'OutgoingBytes'
--- - 'OutgoingRecords'
--- - 'WriteProvisionedThroughputExceeded'
--- - 'ReadProvisionedThroughputExceeded'
--- - 'IteratorAgeMilliseconds'
--- - 'ALL'
---
--- For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/.
+-- | List of shard-level metrics to disable. The following are the valid shard-level metrics. The value "@ALL@ " disables every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
demShardLevelMetrics :: Lens' DisableEnhancedMonitoring [MetricsName]
demShardLevelMetrics = lens _demShardLevelMetrics (\ s a -> s{_demShardLevelMetrics = a}) . _Coerce;
diff --git a/gen/Network/AWS/Kinesis/EnableEnhancedMonitoring.hs b/gen/Network/AWS/Kinesis/EnableEnhancedMonitoring.hs
index 431e9b3..21c65e6 100644
--- a/gen/Network/AWS/Kinesis/EnableEnhancedMonitoring.hs
+++ b/gen/Network/AWS/Kinesis/EnableEnhancedMonitoring.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Enables enhanced Amazon Kinesis stream monitoring for shard-level metrics.
+--
+--
module Network.AWS.Kinesis.EnableEnhancedMonitoring
(
-- * Creating a Request
@@ -44,7 +46,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < EnableEnhancedMonitoring>.
+-- | Represents the input for 'EnableEnhancedMonitoring' .
+--
+--
--
-- /See:/ 'enableEnhancedMonitoring' smart constructor.
data EnableEnhancedMonitoring = EnableEnhancedMonitoring'
@@ -56,9 +60,9 @@ data EnableEnhancedMonitoring = EnableEnhancedMonitoring'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'eemStreamName'
+-- * 'eemStreamName' - The name of the stream for which to enable enhanced monitoring.
--
--- * 'eemShardLevelMetrics'
+-- * 'eemShardLevelMetrics' - List of shard-level metrics to enable. The following are the valid shard-level metrics. The value "@ALL@ " enables every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
enableEnhancedMonitoring
:: Text -- ^ 'eemStreamName'
-> EnableEnhancedMonitoring
@@ -72,20 +76,7 @@ enableEnhancedMonitoring pStreamName_ =
eemStreamName :: Lens' EnableEnhancedMonitoring Text
eemStreamName = lens _eemStreamName (\ s a -> s{_eemStreamName = a});
--- | List of shard-level metrics to enable.
---
--- The following are the valid shard-level metrics. The value \"'ALL'\" enables every metric.
---
--- - 'IncomingBytes'
--- - 'IncomingRecords'
--- - 'OutgoingBytes'
--- - 'OutgoingRecords'
--- - 'WriteProvisionedThroughputExceeded'
--- - 'ReadProvisionedThroughputExceeded'
--- - 'IteratorAgeMilliseconds'
--- - 'ALL'
---
--- For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/.
+-- | List of shard-level metrics to enable. The following are the valid shard-level metrics. The value "@ALL@ " enables every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
eemShardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName]
eemShardLevelMetrics = lens _eemShardLevelMetrics (\ s a -> s{_eemShardLevelMetrics = a}) . _Coerce;
diff --git a/gen/Network/AWS/Kinesis/GetRecords.hs b/gen/Network/AWS/Kinesis/GetRecords.hs
index bc3c117..1bfe899 100644
--- a/gen/Network/AWS/Kinesis/GetRecords.hs
+++ b/gen/Network/AWS/Kinesis/GetRecords.hs
@@ -18,19 +18,21 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Gets data records from an Amazon Kinesis stream\'s shard.
+-- Gets data records from an Amazon Kinesis stream's shard.
--
--- Specify a shard iterator using the 'ShardIterator' parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no 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 records.
--
--- You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call < GetRecords> in a loop. Use < GetShardIterator> to get the shard iterator to specify in the first < GetRecords> call. < GetRecords> returns a new shard iterator in 'NextShardIterator'. Specify the shard iterator returned in 'NextShardIterator' in subsequent calls to < GetRecords>. Note that if the shard has been closed, the shard iterator can\'t return more data and < GetRecords> returns 'null' in 'NextShardIterator'. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
+-- Specify a shard iterator using the @ShardIterator@ parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no 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 records.
--
--- Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don\'t exceed the maximum supported size or throughput by using the 'Limit' parameter to specify the maximum number of records that < GetRecords> can return. Consider your average record size when determining this limit.
+-- You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ ). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call 'GetRecords' in a loop. Use 'GetShardIterator' to get the shard iterator to specify in the first 'GetRecords' call. 'GetRecords' returns a new shard iterator in @NextShardIterator@ . Specify the shard iterator returned in @NextShardIterator@ in subsequent calls to 'GetRecords' . Note that if the shard has been closed, the shard iterator can't return more data and 'GetRecords' returns @null@ in @NextShardIterator@ . You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
--
--- The size of the data returned by < GetRecords> varies depending on the utilization of the shard. The maximum size of data that < GetRecords> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw 'ProvisionedThroughputExceededException'. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw 'ProvisionedThroughputExceededException'. Note that < GetRecords> won\'t return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to < GetRecords>; however, it\'s possible that the application will get exceptions for longer than 1 second.
+-- Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the @Limit@ parameter to specify the maximum number of records that 'GetRecords' can return. Consider your average record size when determining this limit.
--
--- To detect whether the application is falling behind in processing, you can use the 'MillisBehindLatest' response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html Monitoring> in the /Amazon Kinesis Streams Developer Guide/).
+-- The size of the data returned by 'GetRecords' varies depending on the utilization of the shard. The maximum size of data that 'GetRecords' can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw @ProvisionedThroughputExceededException@ . If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw @ProvisionedThroughputExceededException@ . Note that 'GetRecords' won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to 'GetRecords' ; however, it's possible that the application will get exceptions for longer than 1 second.
+--
+-- To detect whether the application is falling behind in processing, you can use the @MillisBehindLatest@ response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html Monitoring> in the /Amazon Kinesis Streams Developer Guide/ ).
+--
+-- Each Amazon Kinesis record includes a value, @ApproximateArrivalTimestamp@ , that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with 'PutRecords' ). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.
--
--- Each Amazon Kinesis record includes a value, 'ApproximateArrivalTimestamp', that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with < PutRecords>). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.
module Network.AWS.Kinesis.GetRecords
(
-- * Creating a Request
@@ -57,7 +59,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < GetRecords>.
+-- | Represents the input for 'GetRecords' .
+--
+--
--
-- /See:/ 'getRecords' smart constructor.
data GetRecords = GetRecords'
@@ -69,9 +73,9 @@ data GetRecords = GetRecords'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'grLimit'
+-- * 'grLimit' - The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, 'GetRecords' throws @InvalidArgumentException@ .
--
--- * 'grShardIterator'
+-- * 'grShardIterator' - The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
getRecords
:: Text -- ^ 'grShardIterator'
-> GetRecords
@@ -81,7 +85,7 @@ getRecords pShardIterator_ =
, _grShardIterator = pShardIterator_
}
--- | The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, < GetRecords> throws 'InvalidArgumentException'.
+-- | The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, 'GetRecords' throws @InvalidArgumentException@ .
grLimit :: Lens' GetRecords (Maybe Natural)
grLimit = lens _grLimit (\ s a -> s{_grLimit = a}) . mapping _Nat;
@@ -127,7 +131,9 @@ instance ToPath GetRecords where
instance ToQuery GetRecords where
toQuery = const mempty
--- | Represents the output for < GetRecords>.
+-- | Represents the output for 'GetRecords' .
+--
+--
--
-- /See:/ 'getRecordsResponse' smart constructor.
data GetRecordsResponse = GetRecordsResponse'
@@ -141,13 +147,13 @@ data GetRecordsResponse = GetRecordsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'grrsNextShardIterator'
+-- * 'grrsNextShardIterator' - The next position in the shard from which to start sequentially reading data records. If set to @null@ , the shard has been closed and the requested iterator will not return any more data.
--
--- * 'grrsMillisBehindLatest'
+-- * 'grrsMillisBehindLatest' - The number of milliseconds the 'GetRecords' response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
--
--- * 'grrsResponseStatus'
+-- * 'grrsResponseStatus' - -- | The response status code.
--
--- * 'grrsRecords'
+-- * 'grrsRecords' - The data records retrieved from the shard.
getRecordsResponse
:: Int -- ^ 'grrsResponseStatus'
-> GetRecordsResponse
@@ -159,15 +165,15 @@ getRecordsResponse pResponseStatus_ =
, _grrsRecords = mempty
}
--- | The next position in the shard from which to start sequentially reading data records. If set to 'null', the shard has been closed and the requested iterator will not return any more data.
+-- | The next position in the shard from which to start sequentially reading data records. If set to @null@ , the shard has been closed and the requested iterator will not return any more data.
grrsNextShardIterator :: Lens' GetRecordsResponse (Maybe Text)
grrsNextShardIterator = lens _grrsNextShardIterator (\ s a -> s{_grrsNextShardIterator = a});
--- | The number of milliseconds the < GetRecords> response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
+-- | The number of milliseconds the 'GetRecords' response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
grrsMillisBehindLatest :: Lens' GetRecordsResponse (Maybe Natural)
grrsMillisBehindLatest = lens _grrsMillisBehindLatest (\ s a -> s{_grrsMillisBehindLatest = a}) . mapping _Nat;
--- | The response status code.
+-- | -- | The response status code.
grrsResponseStatus :: Lens' GetRecordsResponse Int
grrsResponseStatus = lens _grrsResponseStatus (\ s a -> s{_grrsResponseStatus = a});
diff --git a/gen/Network/AWS/Kinesis/GetShardIterator.hs b/gen/Network/AWS/Kinesis/GetShardIterator.hs
index 567396a..aeb8f28 100644
--- a/gen/Network/AWS/Kinesis/GetShardIterator.hs
+++ b/gen/Network/AWS/Kinesis/GetShardIterator.hs
@@ -20,17 +20,19 @@
--
-- Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.
--
+--
-- A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
--
--- You must specify the shard iterator type. For example, you can set the 'ShardIteratorType' parameter to read exactly from the position denoted by a specific sequence number by using the 'AT_SEQUENCE_NUMBER' shard iterator type, or right after the sequence number by using the 'AFTER_SEQUENCE_NUMBER' shard iterator type, using sequence numbers returned by earlier calls to < PutRecord>, < PutRecords>, < GetRecords>, or < DescribeStream>. In the request, you can specify the shard iterator type 'AT_TIMESTAMP' to read records from an arbitrary point in time, 'TRIM_HORIZON' to cause 'ShardIterator' to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or 'LATEST' so that you always read the most recent data in the shard.
+-- You must specify the shard iterator type. For example, you can set the @ShardIteratorType@ parameter to read exactly from the position denoted by a specific sequence number by using the @AT_SEQUENCE_NUMBER@ shard iterator type, or right after the sequence number by using the @AFTER_SEQUENCE_NUMBER@ shard iterator type, using sequence numbers returned by earlier calls to 'PutRecord' , 'PutRecords' , 'GetRecords' , or 'DescribeStream' . In the request, you can specify the shard iterator type @AT_TIMESTAMP@ to read records from an arbitrary point in time, @TRIM_HORIZON@ to cause @ShardIterator@ to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or @LATEST@ so that you always read the most recent data in the shard.
+--
+-- When you read repeatedly from a stream, use a 'GetShardIterator' request to get the first shard iterator for use in your first 'GetRecords' request and for subsequent reads use the shard iterator returned by the 'GetRecords' request in @NextShardIterator@ . A new shard iterator is returned by every 'GetRecords' request in @NextShardIterator@ , which you use in the @ShardIterator@ parameter of the next 'GetRecords' request.
--
--- When you read repeatedly from a stream, use a < GetShardIterator> request to get the first shard iterator for use in your first < GetRecords> request and for subsequent reads use the shard iterator returned by the < GetRecords> request in 'NextShardIterator'. A new shard iterator is returned by every < GetRecords> request in 'NextShardIterator', which you use in the 'ShardIterator' parameter of the next < GetRecords> request.
+-- If a 'GetShardIterator' request is made too often, you receive a @ProvisionedThroughputExceededException@ . For more information about throughput limits, see 'GetRecords' , and <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- If a < GetShardIterator> request is made too often, you receive a 'ProvisionedThroughputExceededException'. For more information about throughput limits, see < GetRecords>, and <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/.
+-- If the shard is closed, 'GetShardIterator' returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of using 'SplitShard' or 'MergeShards' .
--
--- If the shard is closed, < GetShardIterator> returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of using < SplitShard> or < MergeShards>.
+-- 'GetShardIterator' has a limit of 5 transactions per second per account per open shard.
--
--- < GetShardIterator> has a limit of 5 transactions per second per account per open shard.
module Network.AWS.Kinesis.GetShardIterator
(
-- * Creating a Request
@@ -58,7 +60,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'GetShardIterator'.
+-- | Represents the input for @GetShardIterator@ .
+--
+--
--
-- /See:/ 'getShardIterator' smart constructor.
data GetShardIterator = GetShardIterator'
@@ -73,15 +77,15 @@ data GetShardIterator = GetShardIterator'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gsiStartingSequenceNumber'
+-- * 'gsiStartingSequenceNumber' - The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
--
--- * 'gsiTimestamp'
+-- * 'gsiTimestamp' - The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, @2016-04-04T19:58:46.480-00:00@ or @1459799926.480@ . If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
--
--- * 'gsiStreamName'
+-- * 'gsiStreamName' - The name of the Amazon Kinesis stream.
--
--- * 'gsiShardId'
+-- * 'gsiShardId' - The shard ID of the Amazon Kinesis shard to get the iterator for.
--
--- * 'gsiShardIteratorType'
+-- * 'gsiShardIteratorType' - Determines how the shard iterator is used to start reading data records from the shard. The following are the valid Amazon Kinesis shard iterator types: * AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value @StartingSequenceNumber@ . * AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value @StartingSequenceNumber@ . * AT_TIMESTAMP - Start reading from the position denoted by a specific timestamp, provided in the value @Timestamp@ . * TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard. * LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
getShardIterator
:: Text -- ^ 'gsiStreamName'
-> Text -- ^ 'gsiShardId'
@@ -100,7 +104,7 @@ getShardIterator pStreamName_ pShardId_ pShardIteratorType_ =
gsiStartingSequenceNumber :: Lens' GetShardIterator (Maybe Text)
gsiStartingSequenceNumber = lens _gsiStartingSequenceNumber (\ s a -> s{_gsiStartingSequenceNumber = a});
--- | The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, '2016-04-04T19:58:46.480-00:00' or '1459799926.480'. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
+-- | The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, @2016-04-04T19:58:46.480-00:00@ or @1459799926.480@ . If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
gsiTimestamp :: Lens' GetShardIterator (Maybe UTCTime)
gsiTimestamp = lens _gsiTimestamp (\ s a -> s{_gsiTimestamp = a}) . mapping _Time;
@@ -112,15 +116,7 @@ gsiStreamName = lens _gsiStreamName (\ s a -> s{_gsiStreamName = a});
gsiShardId :: Lens' GetShardIterator Text
gsiShardId = lens _gsiShardId (\ s a -> s{_gsiShardId = a});
--- | Determines how the shard iterator is used to start reading data records from the shard.
---
--- The following are the valid Amazon Kinesis shard iterator types:
---
--- - AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value 'StartingSequenceNumber'.
--- - AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value 'StartingSequenceNumber'.
--- - AT_TIMESTAMP - Start reading from the position denoted by a specific timestamp, provided in the value 'Timestamp'.
--- - TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
--- - LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
+-- | Determines how the shard iterator is used to start reading data records from the shard. The following are the valid Amazon Kinesis shard iterator types: * AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value @StartingSequenceNumber@ . * AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value @StartingSequenceNumber@ . * AT_TIMESTAMP - Start reading from the position denoted by a specific timestamp, provided in the value @Timestamp@ . * TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard. * LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType
gsiShardIteratorType = lens _gsiShardIteratorType (\ s a -> s{_gsiShardIteratorType = a});
@@ -163,7 +159,9 @@ instance ToPath GetShardIterator where
instance ToQuery GetShardIterator where
toQuery = const mempty
--- | Represents the output for 'GetShardIterator'.
+-- | Represents the output for @GetShardIterator@ .
+--
+--
--
-- /See:/ 'getShardIteratorResponse' smart constructor.
data GetShardIteratorResponse = GetShardIteratorResponse'
@@ -175,9 +173,9 @@ data GetShardIteratorResponse = GetShardIteratorResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gsirsShardIterator'
+-- * 'gsirsShardIterator' - The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
--
--- * 'gsirsResponseStatus'
+-- * 'gsirsResponseStatus' - -- | The response status code.
getShardIteratorResponse
:: Int -- ^ 'gsirsResponseStatus'
-> GetShardIteratorResponse
@@ -191,7 +189,7 @@ getShardIteratorResponse pResponseStatus_ =
gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text)
gsirsShardIterator = lens _gsirsShardIterator (\ s a -> s{_gsirsShardIterator = a});
--- | The response status code.
+-- | -- | The response status code.
gsirsResponseStatus :: Lens' GetShardIteratorResponse Int
gsirsResponseStatus = lens _gsirsResponseStatus (\ s a -> s{_gsirsResponseStatus = a});
diff --git a/gen/Network/AWS/Kinesis/IncreaseStreamRetentionPeriod.hs b/gen/Network/AWS/Kinesis/IncreaseStreamRetentionPeriod.hs
index ad97802..8bf5f50 100644
--- a/gen/Network/AWS/Kinesis/IncreaseStreamRetentionPeriod.hs
+++ b/gen/Network/AWS/Kinesis/IncreaseStreamRetentionPeriod.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Increases the Amazon Kinesis stream\'s retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream\'s retention period is 168 hours (7 days).
+-- Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).
+--
+--
+-- Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.
--
--- Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream\'s previous retention period) accessible after the operation has been called. For example, if a stream\'s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.
module Network.AWS.Kinesis.IncreaseStreamRetentionPeriod
(
-- * Creating a Request
@@ -42,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for < IncreaseStreamRetentionPeriod>.
+-- | Represents the input for 'IncreaseStreamRetentionPeriod' .
+--
+--
--
-- /See:/ 'increaseStreamRetentionPeriod' smart constructor.
data IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriod'
@@ -54,9 +58,9 @@ data IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriod'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'isrpStreamName'
+-- * 'isrpStreamName' - The name of the stream to modify.
--
--- * 'isrpRetentionPeriodHours'
+-- * 'isrpRetentionPeriodHours' - The new retention period of the stream, in hours. Must be more than the current retention period.
increaseStreamRetentionPeriod
:: Text -- ^ 'isrpStreamName'
-> Natural -- ^ 'isrpRetentionPeriodHours'
diff --git a/gen/Network/AWS/Kinesis/ListStreams.hs b/gen/Network/AWS/Kinesis/ListStreams.hs
index a53f30d..778fd53 100644
--- a/gen/Network/AWS/Kinesis/ListStreams.hs
+++ b/gen/Network/AWS/Kinesis/ListStreams.hs
@@ -20,11 +20,13 @@
--
-- Lists your Amazon Kinesis streams.
--
--- The number of streams may be too large to return from a single call to 'ListStreams'. You can limit the number of returned streams using the 'Limit' parameter. If you do not specify a value for the 'Limit' parameter, Amazon Kinesis uses the default limit, which is currently 10.
--
--- You can detect if there are more streams available to list by using the 'HasMoreStreams' flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the 'ListStreams' request in the 'ExclusiveStartStreamName' parameter in a subsequent request to 'ListStreams'. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
+-- The number of streams may be too large to return from a single call to @ListStreams@ . You can limit the number of returned streams using the @Limit@ parameter. If you do not specify a value for the @Limit@ parameter, Amazon Kinesis uses the default limit, which is currently 10.
+--
+-- You can detect if there are more streams available to list by using the @HasMoreStreams@ flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the @ListStreams@ request in the @ExclusiveStartStreamName@ parameter in a subsequent request to @ListStreams@ . The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
+--
+-- 'ListStreams' has a limit of 5 transactions per second per account.
--
--- < ListStreams> has a limit of 5 transactions per second per account.
--
-- This operation returns paginated results.
module Network.AWS.Kinesis.ListStreams
@@ -53,7 +55,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'ListStreams'.
+-- | Represents the input for @ListStreams@ .
+--
+--
--
-- /See:/ 'listStreams' smart constructor.
data ListStreams = ListStreams'
@@ -65,9 +69,9 @@ data ListStreams = ListStreams'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'lsLimit'
+-- * 'lsLimit' - The maximum number of streams to list.
--
--- * 'lsExclusiveStartStreamName'
+-- * 'lsExclusiveStartStreamName' - The name of the stream to start the list with.
listStreams
:: ListStreams
listStreams =
@@ -131,7 +135,9 @@ instance ToPath ListStreams where
instance ToQuery ListStreams where
toQuery = const mempty
--- | Represents the output for 'ListStreams'.
+-- | Represents the output for @ListStreams@ .
+--
+--
--
-- /See:/ 'listStreamsResponse' smart constructor.
data ListStreamsResponse = ListStreamsResponse'
@@ -144,11 +150,11 @@ data ListStreamsResponse = ListStreamsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'lsrsResponseStatus'
+-- * 'lsrsResponseStatus' - -- | The response status code.
--
--- * 'lsrsStreamNames'
+-- * 'lsrsStreamNames' - The names of the streams that are associated with the AWS account making the @ListStreams@ request.
--
--- * 'lsrsHasMoreStreams'
+-- * 'lsrsHasMoreStreams' - If set to @true@ , there are more streams available to list.
listStreamsResponse
:: Int -- ^ 'lsrsResponseStatus'
-> Bool -- ^ 'lsrsHasMoreStreams'
@@ -160,15 +166,15 @@ listStreamsResponse pResponseStatus_ pHasMoreStreams_ =
, _lsrsHasMoreStreams = pHasMoreStreams_
}
--- | The response status code.
+-- | -- | The response status code.
lsrsResponseStatus :: Lens' ListStreamsResponse Int
lsrsResponseStatus = lens _lsrsResponseStatus (\ s a -> s{_lsrsResponseStatus = a});
--- | The names of the streams that are associated with the AWS account making the 'ListStreams' request.
+-- | The names of the streams that are associated with the AWS account making the @ListStreams@ request.
lsrsStreamNames :: Lens' ListStreamsResponse [Text]
lsrsStreamNames = lens _lsrsStreamNames (\ s a -> s{_lsrsStreamNames = a}) . _Coerce;
--- | If set to 'true', there are more streams available to list.
+-- | If set to @true@ , there are more streams available to list.
lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool
lsrsHasMoreStreams = lens _lsrsHasMoreStreams (\ s a -> s{_lsrsHasMoreStreams = a});
diff --git a/gen/Network/AWS/Kinesis/ListTagsForStream.hs b/gen/Network/AWS/Kinesis/ListTagsForStream.hs
index 4ca1106..72c0c0a 100644
--- a/gen/Network/AWS/Kinesis/ListTagsForStream.hs
+++ b/gen/Network/AWS/Kinesis/ListTagsForStream.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Lists the tags for the specified Amazon Kinesis stream.
+--
+--
module Network.AWS.Kinesis.ListTagsForStream
(
-- * Creating a Request
@@ -45,7 +47,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'ListTagsForStream'.
+-- | Represents the input for @ListTagsForStream@ .
+--
+--
--
-- /See:/ 'listTagsForStream' smart constructor.
data ListTagsForStream = ListTagsForStream'
@@ -58,11 +62,11 @@ data ListTagsForStream = ListTagsForStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ltfsLimit'
+-- * 'ltfsLimit' - The number of tags to return. If this number is less than the total number of tags associated with the stream, @HasMoreTags@ is set to @true@ . To list additional tags, set @ExclusiveStartTagKey@ to the last key in the response.
--
--- * 'ltfsExclusiveStartTagKey'
+-- * 'ltfsExclusiveStartTagKey' - The key to use as the starting point for the list of tags. If this parameter is set, @ListTagsForStream@ gets all tags that occur after @ExclusiveStartTagKey@ .
--
--- * 'ltfsStreamName'
+-- * 'ltfsStreamName' - The name of the stream.
listTagsForStream
:: Text -- ^ 'ltfsStreamName'
-> ListTagsForStream
@@ -73,11 +77,11 @@ listTagsForStream pStreamName_ =
, _ltfsStreamName = pStreamName_
}
--- | The number of tags to return. If this number is less than the total number of tags associated with the stream, 'HasMoreTags' is set to 'true'. To list additional tags, set 'ExclusiveStartTagKey' to the last key in the response.
+-- | The number of tags to return. If this number is less than the total number of tags associated with the stream, @HasMoreTags@ is set to @true@ . To list additional tags, set @ExclusiveStartTagKey@ to the last key in the response.
ltfsLimit :: Lens' ListTagsForStream (Maybe Natural)
ltfsLimit = lens _ltfsLimit (\ s a -> s{_ltfsLimit = a}) . mapping _Nat;
--- | The key to use as the starting point for the list of tags. If this parameter is set, 'ListTagsForStream' gets all tags that occur after 'ExclusiveStartTagKey'.
+-- | The key to use as the starting point for the list of tags. If this parameter is set, @ListTagsForStream@ gets all tags that occur after @ExclusiveStartTagKey@ .
ltfsExclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text)
ltfsExclusiveStartTagKey = lens _ltfsExclusiveStartTagKey (\ s a -> s{_ltfsExclusiveStartTagKey = a});
@@ -123,7 +127,9 @@ instance ToPath ListTagsForStream where
instance ToQuery ListTagsForStream where
toQuery = const mempty
--- | Represents the output for 'ListTagsForStream'.
+-- | Represents the output for @ListTagsForStream@ .
+--
+--
--
-- /See:/ 'listTagsForStreamResponse' smart constructor.
data ListTagsForStreamResponse = ListTagsForStreamResponse'
@@ -136,11 +142,11 @@ data ListTagsForStreamResponse = ListTagsForStreamResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ltfsrsResponseStatus'
+-- * 'ltfsrsResponseStatus' - -- | The response status code.
--
--- * 'ltfsrsTags'
+-- * 'ltfsrsTags' - A list of tags associated with @StreamName@ , starting with the first tag after @ExclusiveStartTagKey@ and up to the specified @Limit@ .
--
--- * 'ltfsrsHasMoreTags'
+-- * 'ltfsrsHasMoreTags' - If set to @true@ , more tags are available. To request additional tags, set @ExclusiveStartTagKey@ to the key of the last tag returned.
listTagsForStreamResponse
:: Int -- ^ 'ltfsrsResponseStatus'
-> Bool -- ^ 'ltfsrsHasMoreTags'
@@ -152,15 +158,15 @@ listTagsForStreamResponse pResponseStatus_ pHasMoreTags_ =
, _ltfsrsHasMoreTags = pHasMoreTags_
}
--- | The response status code.
+-- | -- | The response status code.
ltfsrsResponseStatus :: Lens' ListTagsForStreamResponse Int
ltfsrsResponseStatus = lens _ltfsrsResponseStatus (\ s a -> s{_ltfsrsResponseStatus = a});
--- | A list of tags associated with 'StreamName', starting with the first tag after 'ExclusiveStartTagKey' and up to the specified 'Limit'.
+-- | A list of tags associated with @StreamName@ , starting with the first tag after @ExclusiveStartTagKey@ and up to the specified @Limit@ .
ltfsrsTags :: Lens' ListTagsForStreamResponse [Tag]
ltfsrsTags = lens _ltfsrsTags (\ s a -> s{_ltfsrsTags = a}) . _Coerce;
--- | If set to 'true', more tags are available. To request additional tags, set 'ExclusiveStartTagKey' to the key of the last tag returned.
+-- | If set to @true@ , more tags are available. To request additional tags, set @ExclusiveStartTagKey@ to the key of the last tag returned.
ltfsrsHasMoreTags :: Lens' ListTagsForStreamResponse Bool
ltfsrsHasMoreTags = lens _ltfsrsHasMoreTags (\ s a -> s{_ltfsrsHasMoreTags = a});
diff --git a/gen/Network/AWS/Kinesis/MergeShards.hs b/gen/Network/AWS/Kinesis/MergeShards.hs
index 3d729f0..d2c1e02 100644
--- a/gen/Network/AWS/Kinesis/MergeShards.hs
+++ b/gen/Network/AWS/Kinesis/MergeShards.hs
@@ -18,21 +18,23 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Merges two adjacent shards in an Amazon Kinesis stream and combines them into a single shard to reduce the stream\'s capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
+-- Merges two adjacent shards in an Amazon Kinesis stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
--
--- 'MergeShards' is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html Merge Two Shards> in the /Amazon Kinesis Streams Developer Guide/.
--
--- If the stream is in the 'ACTIVE' state, you can call 'MergeShards'. If a stream is in the 'CREATING', 'UPDATING', or 'DELETING' state, 'MergeShards' returns a 'ResourceInUseException'. If the specified stream does not exist, 'MergeShards' returns a 'ResourceNotFoundException'.
+-- @MergeShards@ is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html Merge Two Shards> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- You can use < DescribeStream> to check the state of the stream, which is returned in 'StreamStatus'.
+-- If the stream is in the @ACTIVE@ state, you can call @MergeShards@ . If a stream is in the @CREATING@ , @UPDATING@ , or @DELETING@ state, @MergeShards@ returns a @ResourceInUseException@ . If the specified stream does not exist, @MergeShards@ returns a @ResourceNotFoundException@ .
--
--- 'MergeShards' is an asynchronous operation. Upon receiving a 'MergeShards' request, Amazon Kinesis immediately returns a response and sets the 'StreamStatus' to 'UPDATING'. After the operation is completed, Amazon Kinesis sets the 'StreamStatus' to 'ACTIVE'. Read and write operations continue to work while the stream is in the 'UPDATING' state.
+-- You can use 'DescribeStream' to check the state of the stream, which is returned in @StreamStatus@ .
--
--- You use < DescribeStream> to determine the shard IDs that are specified in the 'MergeShards' request.
+-- @MergeShards@ is an asynchronous operation. Upon receiving a @MergeShards@ request, Amazon Kinesis immediately returns a response and sets the @StreamStatus@ to @UPDATING@ . After the operation is completed, Amazon Kinesis sets the @StreamStatus@ to @ACTIVE@ . Read and write operations continue to work while the stream is in the @UPDATING@ state.
--
--- If you try to operate on too many streams in parallel using < CreateStream>, < DeleteStream>, 'MergeShards' or < SplitShard>, you will receive a 'LimitExceededException'.
+-- You use 'DescribeStream' to determine the shard IDs that are specified in the @MergeShards@ request.
+--
+-- If you try to operate on too many streams in parallel using 'CreateStream' , 'DeleteStream' , @MergeShards@ or 'SplitShard' , you will receive a @LimitExceededException@ .
+--
+-- @MergeShards@ has limit of 5 transactions per second per account.
--
--- 'MergeShards' has limit of 5 transactions per second per account.
module Network.AWS.Kinesis.MergeShards
(
-- * Creating a Request
@@ -55,7 +57,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'MergeShards'.
+-- | Represents the input for @MergeShards@ .
+--
+--
--
-- /See:/ 'mergeShards' smart constructor.
data MergeShards = MergeShards'
@@ -68,11 +72,11 @@ data MergeShards = MergeShards'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'msStreamName'
+-- * 'msStreamName' - The name of the stream for the merge.
--
--- * 'msShardToMerge'
+-- * 'msShardToMerge' - The shard ID of the shard to combine with the adjacent shard for the merge.
--
--- * 'msAdjacentShardToMerge'
+-- * 'msAdjacentShardToMerge' - The shard ID of the adjacent shard for the merge.
mergeShards
:: Text -- ^ 'msStreamName'
-> Text -- ^ 'msShardToMerge'
diff --git a/gen/Network/AWS/Kinesis/PutRecord.hs b/gen/Network/AWS/Kinesis/PutRecord.hs
index 4e1a2c9..38c062a 100644
--- a/gen/Network/AWS/Kinesis/PutRecord.hs
+++ b/gen/Network/AWS/Kinesis/PutRecord.hs
@@ -18,23 +18,25 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Writes a single data record into an Amazon Kinesis stream. Call 'PutRecord' to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
+-- Writes a single data record into an Amazon Kinesis stream. Call @PutRecord@ to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
+--
--
-- You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
--
--- The data blob can be any type of data; for example, a segment from a log file, geographic\/location data, website clickstream data, and so on.
+-- The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
--
-- The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
--
--- Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the 'ExplicitHashKey' parameter. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/.
+-- Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the @ExplicitHashKey@ parameter. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- 'PutRecord' returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
+-- @PutRecord@ returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
--
--- Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the 'SequenceNumberForOrdering' parameter. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/.
+-- Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the @SequenceNumberForOrdering@ parameter. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- If a 'PutRecord' request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, 'PutRecord' throws 'ProvisionedThroughputExceededException'.
+-- If a @PutRecord@ request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, @PutRecord@ throws @ProvisionedThroughputExceededException@ .
--
-- Data records are accessible for only 24 hours from the time that they are added to a stream.
+--
module Network.AWS.Kinesis.PutRecord
(
-- * Creating a Request
@@ -63,7 +65,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'PutRecord'.
+-- | Represents the input for @PutRecord@ .
+--
+--
--
-- /See:/ 'putRecord' smart constructor.
data PutRecord = PutRecord'
@@ -78,15 +82,15 @@ data PutRecord = PutRecord'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'prExplicitHashKey'
+-- * 'prExplicitHashKey' - The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
--
--- * 'prSequenceNumberForOrdering'
+-- * 'prSequenceNumberForOrdering' - Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the @SequenceNumberForOrdering@ of record /n/ to the sequence number of record /n-1/ (as returned in the result when putting record /n-1/ ). If this parameter is not set, records will be coarsely ordered based on arrival time.
--
--- * 'prStreamName'
+-- * 'prStreamName' - The name of the stream to put the data record into.
--
--- * 'prData'
+-- * 'prData' - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
--
--- * 'prPartitionKey'
+-- * 'prPartitionKey' - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
putRecord
:: Text -- ^ 'prStreamName'
-> ByteString -- ^ 'prData'
@@ -105,7 +109,7 @@ putRecord pStreamName_ pData_ pPartitionKey_ =
prExplicitHashKey :: Lens' PutRecord (Maybe Text)
prExplicitHashKey = lens _prExplicitHashKey (\ s a -> s{_prExplicitHashKey = a});
--- | Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the 'SequenceNumberForOrdering' of record /n/ to the sequence number of record /n-1/ (as returned in the result when putting record /n-1/). If this parameter is not set, records will be coarsely ordered based on arrival time.
+-- | Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the @SequenceNumberForOrdering@ of record /n/ to the sequence number of record /n-1/ (as returned in the result when putting record /n-1/ ). If this parameter is not set, records will be coarsely ordered based on arrival time.
prSequenceNumberForOrdering :: Lens' PutRecord (Maybe Text)
prSequenceNumberForOrdering = lens _prSequenceNumberForOrdering (\ s a -> s{_prSequenceNumberForOrdering = a});
@@ -113,13 +117,7 @@ prSequenceNumberForOrdering = lens _prSequenceNumberForOrdering (\ s a -> s{_prS
prStreamName :: Lens' PutRecord Text
prStreamName = lens _prStreamName (\ s a -> s{_prStreamName = a});
--- | The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
---
--- /Note:/ This 'Lens' automatically encodes and decodes Base64 data,
--- despite what the AWS documentation might say.
--- The underlying isomorphism will encode to Base64 representation during
--- serialisation, and decode from Base64 representation during deserialisation.
--- This 'Lens' accepts and returns only raw unencoded data.
+-- | The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
prData :: Lens' PutRecord ByteString
prData = lens _prData (\ s a -> s{_prData = a}) . _Base64;
@@ -167,7 +165,9 @@ instance ToPath PutRecord where
instance ToQuery PutRecord where
toQuery = const mempty
--- | Represents the output for 'PutRecord'.
+-- | Represents the output for @PutRecord@ .
+--
+--
--
-- /See:/ 'putRecordResponse' smart constructor.
data PutRecordResponse = PutRecordResponse'
@@ -180,11 +180,11 @@ data PutRecordResponse = PutRecordResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'prrsResponseStatus'
+-- * 'prrsResponseStatus' - -- | The response status code.
--
--- * 'prrsShardId'
+-- * 'prrsShardId' - The shard ID of the shard where the data record was placed.
--
--- * 'prrsSequenceNumber'
+-- * 'prrsSequenceNumber' - The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
putRecordResponse
:: Int -- ^ 'prrsResponseStatus'
-> Text -- ^ 'prrsShardId'
@@ -197,7 +197,7 @@ putRecordResponse pResponseStatus_ pShardId_ pSequenceNumber_ =
, _prrsSequenceNumber = pSequenceNumber_
}
--- | The response status code.
+-- | -- | The response status code.
prrsResponseStatus :: Lens' PutRecordResponse Int
prrsResponseStatus = lens _prrsResponseStatus (\ s a -> s{_prrsResponseStatus = a});
diff --git a/gen/Network/AWS/Kinesis/PutRecords.hs b/gen/Network/AWS/Kinesis/PutRecords.hs
index 0f4d817..40385ac 100644
--- a/gen/Network/AWS/Kinesis/PutRecords.hs
+++ b/gen/Network/AWS/Kinesis/PutRecords.hs
@@ -18,27 +18,29 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a 'PutRecords' request). Use this operation to send data into the stream for data ingestion and processing.
+-- Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a @PutRecords@ request). Use this operation to send data into the stream for data ingestion and processing.
--
--- Each 'PutRecords' request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
--
--- You must specify the name of the stream that captures, stores, and transports the data; and an array of request 'Records', with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
+-- Each @PutRecords@ request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
--
--- The data blob can be any type of data; for example, a segment from a log file, geographic\/location data, website clickstream data, and so on.
+-- You must specify the name of the stream that captures, stores, and transports the data; and an array of request @Records@ , with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
--
--- The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/.
+-- The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
--
--- Each record in the 'Records' array may include an optional parameter, 'ExplicitHashKey', which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords Adding Multiple Records with PutRecords> in the /Amazon Kinesis Streams Developer Guide/.
+-- The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- The 'PutRecords' response includes an array of response 'Records'. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response 'Records' array always includes the same number of records as the request array.
+-- Each record in the @Records@ array may include an optional parameter, @ExplicitHashKey@ , which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords Adding Multiple Records with PutRecords> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- The response 'Records' array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each 'PutRecords' request. A single record failure does not stop the processing of subsequent records.
+-- The @PutRecords@ response includes an array of response @Records@ . Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response @Records@ array always includes the same number of records as the request array.
--
--- A successfully-processed record includes 'ShardId' and 'SequenceNumber' values. The 'ShardId' parameter identifies the shard in the stream where the record is stored. The 'SequenceNumber' parameter is an identifier assigned to the put record, unique to all records in the stream.
+-- The response @Records@ array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each @PutRecords@ request. A single record failure does not stop the processing of subsequent records.
--
--- An unsuccessfully-processed record includes 'ErrorCode' and 'ErrorMessage' values. 'ErrorCode' reflects the type of error and can be one of the following values: 'ProvisionedThroughputExceededException' or 'InternalFailure'. 'ErrorMessage' provides more detailed information about the 'ProvisionedThroughputExceededException' exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords Adding Multiple Records with PutRecords> in the /Amazon Kinesis Streams Developer Guide/.
+-- A successfully-processed record includes @ShardId@ and @SequenceNumber@ values. The @ShardId@ parameter identifies the shard in the stream where the record is stored. The @SequenceNumber@ parameter is an identifier assigned to the put record, unique to all records in the stream.
+--
+-- An unsuccessfully-processed record includes @ErrorCode@ and @ErrorMessage@ values. @ErrorCode@ reflects the type of error and can be one of the following values: @ProvisionedThroughputExceededException@ or @InternalFailure@ . @ErrorMessage@ provides more detailed information about the @ProvisionedThroughputExceededException@ exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords Adding Multiple Records with PutRecords> in the /Amazon Kinesis Streams Developer Guide/ .
+--
+-- By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the 'DecreaseStreamRetentionPeriod' and 'IncreaseStreamRetentionPeriod' operations.
--
--- By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the < DecreaseStreamRetentionPeriod> and < IncreaseStreamRetentionPeriod> operations.
module Network.AWS.Kinesis.PutRecords
(
-- * Creating a Request
@@ -64,7 +66,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | A 'PutRecords' request.
+-- | A @PutRecords@ request.
+--
+--
--
-- /See:/ 'putRecords' smart constructor.
data PutRecords = PutRecords'
@@ -76,9 +80,9 @@ data PutRecords = PutRecords'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'pRecordEntries'
+-- * 'pRecordEntries' - The records associated with the request.
--
--- * 'pStreamName'
+-- * 'pStreamName' - The stream name associated with the request.
putRecords
:: NonEmpty PutRecordsRequestEntry -- ^ 'pRecordEntries'
-> Text -- ^ 'pStreamName'
@@ -133,7 +137,9 @@ instance ToPath PutRecords where
instance ToQuery PutRecords where
toQuery = const mempty
--- | 'PutRecords' results.
+-- | @PutRecords@ results.
+--
+--
--
-- /See:/ 'putRecordsResponse' smart constructor.
data PutRecordsResponse = PutRecordsResponse'
@@ -146,11 +152,11 @@ data PutRecordsResponse = PutRecordsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'prsFailedRecordCount'
+-- * 'prsFailedRecordCount' - The number of unsuccessfully processed records in a @PutRecords@ request.
--
--- * 'prsResponseStatus'
+-- * 'prsResponseStatus' - -- | The response status code.
--
--- * 'prsRecords'
+-- * 'prsRecords' - An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes @SequenceNumber@ and @ShardId@ in the result. A record that fails to be added to a stream includes @ErrorCode@ and @ErrorMessage@ in the result.
putRecordsResponse
:: Int -- ^ 'prsResponseStatus'
-> NonEmpty PutRecordsResultEntry -- ^ 'prsRecords'
@@ -162,15 +168,15 @@ putRecordsResponse pResponseStatus_ pRecords_ =
, _prsRecords = _List1 # pRecords_
}
--- | The number of unsuccessfully processed records in a 'PutRecords' request.
+-- | The number of unsuccessfully processed records in a @PutRecords@ request.
prsFailedRecordCount :: Lens' PutRecordsResponse (Maybe Natural)
prsFailedRecordCount = lens _prsFailedRecordCount (\ s a -> s{_prsFailedRecordCount = a}) . mapping _Nat;
--- | The response status code.
+-- | -- | The response status code.
prsResponseStatus :: Lens' PutRecordsResponse Int
prsResponseStatus = lens _prsResponseStatus (\ s a -> s{_prsResponseStatus = a});
--- | An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes 'SequenceNumber' and 'ShardId' in the result. A record that fails to be added to a stream includes 'ErrorCode' and 'ErrorMessage' in the result.
+-- | An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes @SequenceNumber@ and @ShardId@ in the result. A record that fails to be added to a stream includes @ErrorCode@ and @ErrorMessage@ in the result.
prsRecords :: Lens' PutRecordsResponse (NonEmpty PutRecordsResultEntry)
prsRecords = lens _prsRecords (\ s a -> s{_prsRecords = a}) . _List1;
diff --git a/gen/Network/AWS/Kinesis/RemoveTagsFromStream.hs b/gen/Network/AWS/Kinesis/RemoveTagsFromStream.hs
index 8fa0f22..033e531 100644
--- a/gen/Network/AWS/Kinesis/RemoveTagsFromStream.hs
+++ b/gen/Network/AWS/Kinesis/RemoveTagsFromStream.hs
@@ -20,7 +20,9 @@
--
-- Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
--
+--
-- If you specify a tag that does not exist, it is ignored.
+--
module Network.AWS.Kinesis.RemoveTagsFromStream
(
-- * Creating a Request
@@ -42,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'RemoveTagsFromStream'.
+-- | Represents the input for @RemoveTagsFromStream@ .
+--
+--
--
-- /See:/ 'removeTagsFromStream' smart constructor.
data RemoveTagsFromStream = RemoveTagsFromStream'
@@ -54,9 +58,9 @@ data RemoveTagsFromStream = RemoveTagsFromStream'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'rtfsStreamName'
+-- * 'rtfsStreamName' - The name of the stream.
--
--- * 'rtfsTagKeys'
+-- * 'rtfsTagKeys' - A list of tag keys. Each corresponding tag is removed from the stream.
removeTagsFromStream
:: Text -- ^ 'rtfsStreamName'
-> NonEmpty Text -- ^ 'rtfsTagKeys'
diff --git a/gen/Network/AWS/Kinesis/SplitShard.hs b/gen/Network/AWS/Kinesis/SplitShard.hs
index a19ab6e..6eb8289 100644
--- a/gen/Network/AWS/Kinesis/SplitShard.hs
+++ b/gen/Network/AWS/Kinesis/SplitShard.hs
@@ -18,25 +18,27 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Splits a shard into two new shards in the Amazon Kinesis stream to increase the stream\'s capacity to ingest and transport data. 'SplitShard' is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.
+-- Splits a shard into two new shards in the Amazon Kinesis stream to increase the stream's capacity to ingest and transport data. @SplitShard@ is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.
--
--- You can also use 'SplitShard' when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call 'SplitShard' to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.
--
--- You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html Split a Shard> in the /Amazon Kinesis Streams Developer Guide/.
+-- You can also use @SplitShard@ when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call @SplitShard@ to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.
--
--- You can use < DescribeStream> to determine the shard ID and hash key values for the 'ShardToSplit' and 'NewStartingHashKey' parameters that are specified in the 'SplitShard' request.
+-- You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html Split a Shard> in the /Amazon Kinesis Streams Developer Guide/ .
--
--- 'SplitShard' is an asynchronous operation. Upon receiving a 'SplitShard' request, Amazon Kinesis immediately returns a response and sets the stream status to 'UPDATING'. After the operation is completed, Amazon Kinesis sets the stream status to 'ACTIVE'. Read and write operations continue to work while the stream is in the 'UPDATING' state.
+-- You can use 'DescribeStream' to determine the shard ID and hash key values for the @ShardToSplit@ and @NewStartingHashKey@ parameters that are specified in the @SplitShard@ request.
--
--- You can use 'DescribeStream' to check the status of the stream, which is returned in 'StreamStatus'. If the stream is in the 'ACTIVE' state, you can call 'SplitShard'. If a stream is in 'CREATING' or 'UPDATING' or 'DELETING' states, 'DescribeStream' returns a 'ResourceInUseException'.
+-- @SplitShard@ is an asynchronous operation. Upon receiving a @SplitShard@ request, Amazon Kinesis immediately returns a response and sets the stream status to @UPDATING@ . After the operation is completed, Amazon Kinesis sets the stream status to @ACTIVE@ . Read and write operations continue to work while the stream is in the @UPDATING@ state.
--
--- If the specified stream does not exist, 'DescribeStream' returns a 'ResourceNotFoundException'. If you try to create more shards than are authorized for your account, you receive a 'LimitExceededException'.
+-- You can use @DescribeStream@ to check the status of the stream, which is returned in @StreamStatus@ . If the stream is in the @ACTIVE@ state, you can call @SplitShard@ . If a stream is in @CREATING@ or @UPDATING@ or @DELETING@ states, @DescribeStream@ returns a @ResourceInUseException@ .
--
--- For the default shard limit for an AWS account, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/. If you need to increase this limit, <http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html contact AWS Support>.
+-- If the specified stream does not exist, @DescribeStream@ returns a @ResourceNotFoundException@ . If you try to create more shards than are authorized for your account, you receive a @LimitExceededException@ .
--
--- If you try to operate on too many streams simultaneously using < CreateStream>, < DeleteStream>, < MergeShards>, and\/or < SplitShard>, you receive a 'LimitExceededException'.
+-- For the default shard limit for an AWS account, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ . If you need to increase this limit, <http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html contact AWS Support> .
+--
+-- If you try to operate on too many streams simultaneously using 'CreateStream' , 'DeleteStream' , 'MergeShards' , and/or 'SplitShard' , you receive a @LimitExceededException@ .
+--
+-- @SplitShard@ has limit of 5 transactions per second per account.
--
--- 'SplitShard' has limit of 5 transactions per second per account.
module Network.AWS.Kinesis.SplitShard
(
-- * Creating a Request
@@ -59,7 +61,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Represents the input for 'SplitShard'.
+-- | Represents the input for @SplitShard@ .
+--
+--
--
-- /See:/ 'splitShard' smart constructor.
data SplitShard = SplitShard'
@@ -72,11 +76,11 @@ data SplitShard = SplitShard'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ssStreamName'
+-- * 'ssStreamName' - The name of the stream for the shard split.
--
--- * 'ssShardToSplit'
+-- * 'ssShardToSplit' - The shard ID of the shard to split.
--
--- * 'ssNewStartingHashKey'
+-- * 'ssNewStartingHashKey' - A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for @NewStartingHashKey@ must be in the range of hash keys being mapped into the shard. The @NewStartingHashKey@ hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
splitShard
:: Text -- ^ 'ssStreamName'
-> Text -- ^ 'ssShardToSplit'
@@ -97,7 +101,7 @@ ssStreamName = lens _ssStreamName (\ s a -> s{_ssStreamName = a});
ssShardToSplit :: Lens' SplitShard Text
ssShardToSplit = lens _ssShardToSplit (\ s a -> s{_ssShardToSplit = a});
--- | A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for 'NewStartingHashKey' must be in the range of hash keys being mapped into the shard. The 'NewStartingHashKey' hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
+-- | A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for @NewStartingHashKey@ must be in the range of hash keys being mapped into the shard. The @NewStartingHashKey@ hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
ssNewStartingHashKey :: Lens' SplitShard Text
ssNewStartingHashKey = lens _ssNewStartingHashKey (\ s a -> s{_ssNewStartingHashKey = a});
diff --git a/gen/Network/AWS/Kinesis/Types.hs b/gen/Network/AWS/Kinesis/Types.hs
index b30c5c9..adb700a 100644
--- a/gen/Network/AWS/Kinesis/Types.hs
+++ b/gen/Network/AWS/Kinesis/Types.hs
@@ -26,6 +26,9 @@ module Network.AWS.Kinesis.Types
-- * MetricsName
, MetricsName (..)
+ -- * ScalingType
+ , ScalingType (..)
+
-- * ShardIteratorType
, ShardIteratorType (..)
@@ -97,6 +100,7 @@ module Network.AWS.Kinesis.Types
, sdShards
, sdHasMoreShards
, sdRetentionPeriodHours
+ , sdStreamCreationTimestamp
, sdEnhancedMonitoring
-- * Tag
@@ -112,7 +116,7 @@ import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Sign.V4
--- | API version '2013-12-02' of the Amazon Kinesis SDK configuration.
+-- | API version @2013-12-02@ of the Amazon Kinesis SDK configuration.
kinesis :: Service
kinesis =
Service
@@ -147,27 +151,39 @@ kinesis =
| otherwise = Nothing
-- | The provided iterator exceeds the maximum age allowed.
+--
+--
_ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError
_ExpiredIteratorException = _ServiceError . hasCode "ExpiredIteratorException"
--- | A specified parameter exceeds its restrictions, is not supported, or can\'t be used. For more information, see the returned message.
+-- | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
+--
+--
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidArgumentException = _ServiceError . hasCode "InvalidArgumentException"
--- | The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/, and <http://docs.aws.amazon.com/general/latest/gr/api-retries.html Error Retries and Exponential Backoff in AWS> in the /AWS General Reference/.
+-- | The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ , and <http://docs.aws.amazon.com/general/latest/gr/api-retries.html Error Retries and Exponential Backoff in AWS> in the /AWS General Reference/ .
+--
+--
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_ProvisionedThroughputExceededException =
_ServiceError . hasCode "ProvisionedThroughputExceededException"
--- | The requested resource could not be found. The stream might not be specified correctly, or it might not be in the 'ACTIVE' state if the operation requires it.
+-- | The requested resource could not be found. The stream might not be specified correctly.
+--
+--
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException =
_ServiceError . hasCode "ResourceNotFoundException"
-- | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
+--
+--
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException = _ServiceError . hasCode "LimitExceededException"
--- | The resource is not available for this operation. For successful operation, the resource needs to be in the 'ACTIVE' state.
+-- | The resource is not available for this operation. For successful operation, the resource needs to be in the @ACTIVE@ state.
+--
+--
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceInUseException = _ServiceError . hasCode "ResourceInUseException"
diff --git a/gen/Network/AWS/Kinesis/Types/Product.hs b/gen/Network/AWS/Kinesis/Types/Product.hs
index 11d8973..66e8227 100644
--- a/gen/Network/AWS/Kinesis/Types/Product.hs
+++ b/gen/Network/AWS/Kinesis/Types/Product.hs
@@ -23,6 +23,8 @@ import Network.AWS.Prelude
-- | Represents enhanced metrics types.
--
+--
+--
-- /See:/ 'enhancedMetrics' smart constructor.
newtype EnhancedMetrics = EnhancedMetrics'
{ _emShardLevelMetrics :: Maybe [MetricsName]
@@ -32,7 +34,7 @@ newtype EnhancedMetrics = EnhancedMetrics'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'emShardLevelMetrics'
+-- * 'emShardLevelMetrics' - List of shard-level metrics. The following are the valid shard-level metrics. The value "@ALL@ " enhances every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
enhancedMetrics
:: EnhancedMetrics
enhancedMetrics =
@@ -40,20 +42,7 @@ enhancedMetrics =
{ _emShardLevelMetrics = Nothing
}
--- | List of shard-level metrics.
---
--- The following are the valid shard-level metrics. The value \"'ALL'\" enhances every metric.
---
--- - 'IncomingBytes'
--- - 'IncomingRecords'
--- - 'OutgoingBytes'
--- - 'OutgoingRecords'
--- - 'WriteProvisionedThroughputExceeded'
--- - 'ReadProvisionedThroughputExceeded'
--- - 'IteratorAgeMilliseconds'
--- - 'ALL'
---
--- For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/.
+-- | List of shard-level metrics. The following are the valid shard-level metrics. The value "@ALL@ " enhances every metric. * @IncomingBytes@ * @IncomingRecords@ * @OutgoingBytes@ * @OutgoingRecords@ * @WriteProvisionedThroughputExceeded@ * @ReadProvisionedThroughputExceeded@ * @IteratorAgeMilliseconds@ * @ALL@ For more information, see <http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch> in the /Amazon Kinesis Streams Developer Guide/ .
emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName]
emShardLevelMetrics = lens _emShardLevelMetrics (\ s a -> s{_emShardLevelMetrics = a}) . _Default . _Coerce;
@@ -68,7 +57,9 @@ instance Hashable EnhancedMetrics
instance NFData EnhancedMetrics
--- | Represents the output for < EnableEnhancedMonitoring> and < DisableEnhancedMonitoring>.
+-- | Represents the output for 'EnableEnhancedMonitoring' and 'DisableEnhancedMonitoring' .
+--
+--
--
-- /See:/ 'enhancedMonitoringOutput' smart constructor.
data EnhancedMonitoringOutput = EnhancedMonitoringOutput'
@@ -81,11 +72,11 @@ data EnhancedMonitoringOutput = EnhancedMonitoringOutput'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'emoDesiredShardLevelMetrics'
+-- * 'emoDesiredShardLevelMetrics' - Represents the list of all the metrics that would be in the enhanced state after the operation.
--
--- * 'emoCurrentShardLevelMetrics'
+-- * 'emoCurrentShardLevelMetrics' - Represents the current state of the metrics that are in the enhanced state before the operation.
--
--- * 'emoStreamName'
+-- * 'emoStreamName' - The name of the Amazon Kinesis stream.
enhancedMonitoringOutput
:: EnhancedMonitoringOutput
enhancedMonitoringOutput =
@@ -122,6 +113,8 @@ instance NFData EnhancedMonitoringOutput
-- | The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
--
+--
+--
-- /See:/ 'hashKeyRange' smart constructor.
data HashKeyRange = HashKeyRange'
{ _hkrStartingHashKey :: !Text
@@ -132,9 +125,9 @@ data HashKeyRange = HashKeyRange'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'hkrStartingHashKey'
+-- * 'hkrStartingHashKey' - The starting hash key of the hash key range.
--
--- * 'hkrEndingHashKey'
+-- * 'hkrEndingHashKey' - The ending hash key of the hash key range.
hashKeyRange
:: Text -- ^ 'hkrStartingHashKey'
-> Text -- ^ 'hkrEndingHashKey'
@@ -164,7 +157,9 @@ instance Hashable HashKeyRange
instance NFData HashKeyRange
--- | Represents the output for 'PutRecords'.
+-- | Represents the output for @PutRecords@ .
+--
+--
--
-- /See:/ 'putRecordsRequestEntry' smart constructor.
data PutRecordsRequestEntry = PutRecordsRequestEntry'
@@ -177,11 +172,11 @@ data PutRecordsRequestEntry = PutRecordsRequestEntry'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'prreExplicitHashKey'
+-- * 'prreExplicitHashKey' - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
--
--- * 'prreData'
+-- * 'prreData' - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
--
--- * 'prrePartitionKey'
+-- * 'prrePartitionKey' - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
putRecordsRequestEntry
:: ByteString -- ^ 'prreData'
-> Text -- ^ 'prrePartitionKey'
@@ -197,13 +192,7 @@ putRecordsRequestEntry pData_ pPartitionKey_ =
prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)
prreExplicitHashKey = lens _prreExplicitHashKey (\ s a -> s{_prreExplicitHashKey = a});
--- | The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
---
--- /Note:/ This 'Lens' automatically encodes and decodes Base64 data,
--- despite what the AWS documentation might say.
--- The underlying isomorphism will encode to Base64 representation during
--- serialisation, and decode from Base64 representation during deserialisation.
--- This 'Lens' accepts and returns only raw unencoded data.
+-- | The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
prreData :: Lens' PutRecordsRequestEntry ByteString
prreData = lens _prreData (\ s a -> s{_prreData = a}) . _Base64;
@@ -223,7 +212,9 @@ instance ToJSON PutRecordsRequestEntry where
Just ("Data" .= _prreData),
Just ("PartitionKey" .= _prrePartitionKey)])
--- | Represents the result of an individual record from a 'PutRecords' request. A record that is successfully added to a stream includes 'SequenceNumber' and 'ShardId' in the result. A record that fails to be added to the stream includes 'ErrorCode' and 'ErrorMessage' in the result.
+-- | Represents the result of an individual record from a @PutRecords@ request. A record that is successfully added to a stream includes @SequenceNumber@ and @ShardId@ in the result. A record that fails to be added to the stream includes @ErrorCode@ and @ErrorMessage@ in the result.
+--
+--
--
-- /See:/ 'putRecordsResultEntry' smart constructor.
data PutRecordsResultEntry = PutRecordsResultEntry'
@@ -237,13 +228,13 @@ data PutRecordsResultEntry = PutRecordsResultEntry'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'prreSequenceNumber'
+-- * 'prreSequenceNumber' - The sequence number for an individual record result.
--
--- * 'prreErrorCode'
+-- * 'prreErrorCode' - The error code for an individual record result. @ErrorCodes@ can be either @ProvisionedThroughputExceededException@ or @InternalFailure@ .
--
--- * 'prreErrorMessage'
+-- * 'prreErrorMessage' - The error message for an individual record result. An @ErrorCode@ value of @ProvisionedThroughputExceededException@ has an error message that includes the account ID, stream name, and shard ID. An @ErrorCode@ value of @InternalFailure@ has the error message @"Internal Service Failure"@ .
--
--- * 'prreShardId'
+-- * 'prreShardId' - The shard ID for an individual record result.
putRecordsResultEntry
:: PutRecordsResultEntry
putRecordsResultEntry =
@@ -258,11 +249,11 @@ putRecordsResultEntry =
prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)
prreSequenceNumber = lens _prreSequenceNumber (\ s a -> s{_prreSequenceNumber = a});
--- | The error code for an individual record result. 'ErrorCodes' can be either 'ProvisionedThroughputExceededException' or 'InternalFailure'.
+-- | The error code for an individual record result. @ErrorCodes@ can be either @ProvisionedThroughputExceededException@ or @InternalFailure@ .
prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text)
prreErrorCode = lens _prreErrorCode (\ s a -> s{_prreErrorCode = a});
--- | The error message for an individual record result. An 'ErrorCode' value of 'ProvisionedThroughputExceededException' has an error message that includes the account ID, stream name, and shard ID. An 'ErrorCode' value of 'InternalFailure' has the error message '\"Internal Service Failure\"'.
+-- | The error message for an individual record result. An @ErrorCode@ value of @ProvisionedThroughputExceededException@ has an error message that includes the account ID, stream name, and shard ID. An @ErrorCode@ value of @InternalFailure@ has the error message @"Internal Service Failure"@ .
prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text)
prreErrorMessage = lens _prreErrorMessage (\ s a -> s{_prreErrorMessage = a});
@@ -285,6 +276,8 @@ instance NFData PutRecordsResultEntry
-- | The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
--
+--
+--
-- /See:/ 'record' smart constructor.
data Record = Record'
{ _rApproximateArrivalTimestamp :: !(Maybe POSIX)
@@ -297,13 +290,13 @@ data Record = Record'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'rApproximateArrivalTimestamp'
+-- * 'rApproximateArrivalTimestamp' - The approximate time that the record was inserted into the stream.
--
--- * 'rSequenceNumber'
+-- * 'rSequenceNumber' - The unique identifier of the record in the stream.
--
--- * 'rData'
+-- * 'rData' - The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
--
--- * 'rPartitionKey'
+-- * 'rPartitionKey' - Identifies which shard in the stream the data record is assigned to.
record
:: Text -- ^ 'rSequenceNumber'
-> ByteString -- ^ 'rData'
@@ -325,13 +318,7 @@ rApproximateArrivalTimestamp = lens _rApproximateArrivalTimestamp (\ s a -> s{_r
rSequenceNumber :: Lens' Record Text
rSequenceNumber = lens _rSequenceNumber (\ s a -> s{_rSequenceNumber = a});
--- | The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
---
--- /Note:/ This 'Lens' automatically encodes and decodes Base64 data,
--- despite what the AWS documentation might say.
--- The underlying isomorphism will encode to Base64 representation during
--- serialisation, and decode from Base64 representation during deserialisation.
--- This 'Lens' accepts and returns only raw unencoded data.
+-- | The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data.
rData :: Lens' Record ByteString
rData = lens _rData (\ s a -> s{_rData = a}) . _Base64;
@@ -355,6 +342,8 @@ instance NFData Record
-- | The range of possible sequence numbers for the shard.
--
+--
+--
-- /See:/ 'sequenceNumberRange' smart constructor.
data SequenceNumberRange = SequenceNumberRange'
{ _snrEndingSequenceNumber :: !(Maybe Text)
@@ -365,9 +354,9 @@ data SequenceNumberRange = SequenceNumberRange'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'snrEndingSequenceNumber'
+-- * 'snrEndingSequenceNumber' - The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of @null@ .
--
--- * 'snrStartingSequenceNumber'
+-- * 'snrStartingSequenceNumber' - The starting sequence number for the range.
sequenceNumberRange
:: Text -- ^ 'snrStartingSequenceNumber'
-> SequenceNumberRange
@@ -377,7 +366,7 @@ sequenceNumberRange pStartingSequenceNumber_ =
, _snrStartingSequenceNumber = pStartingSequenceNumber_
}
--- | The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of 'null'.
+-- | The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of @null@ .
snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)
snrEndingSequenceNumber = lens _snrEndingSequenceNumber (\ s a -> s{_snrEndingSequenceNumber = a});
@@ -399,6 +388,8 @@ instance NFData SequenceNumberRange
-- | A uniquely identified group of data records in an Amazon Kinesis stream.
--
+--
+--
-- /See:/ 'shard' smart constructor.
data Shard = Shard'
{ _sAdjacentParentShardId :: !(Maybe Text)
@@ -412,15 +403,15 @@ data Shard = Shard'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sAdjacentParentShardId'
+-- * 'sAdjacentParentShardId' - The shard ID of the shard adjacent to the shard's parent.
--
--- * 'sParentShardId'
+-- * 'sParentShardId' - The shard ID of the shard's parent.
--
--- * 'sShardId'
+-- * 'sShardId' - The unique identifier of the shard within the stream.
--
--- * 'sHashKeyRange'
+-- * 'sHashKeyRange' - The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
--
--- * 'sSequenceNumberRange'
+-- * 'sSequenceNumberRange' - The range of possible sequence numbers for the shard.
shard
:: Text -- ^ 'sShardId'
-> HashKeyRange -- ^ 'sHashKeyRange'
@@ -435,11 +426,11 @@ shard pShardId_ pHashKeyRange_ pSequenceNumberRange_ =
, _sSequenceNumberRange = pSequenceNumberRange_
}
--- | The shard ID of the shard adjacent to the shard\'s parent.
+-- | The shard ID of the shard adjacent to the shard's parent.
sAdjacentParentShardId :: Lens' Shard (Maybe Text)
sAdjacentParentShardId = lens _sAdjacentParentShardId (\ s a -> s{_sAdjacentParentShardId = a});
--- | The shard ID of the shard\'s parent.
+-- | The shard ID of the shard's parent.
sParentShardId :: Lens' Shard (Maybe Text)
sParentShardId = lens _sParentShardId (\ s a -> s{_sParentShardId = a});
@@ -470,44 +461,50 @@ instance Hashable Shard
instance NFData Shard
--- | Represents the output for < DescribeStream>.
+-- | Represents the output for 'DescribeStream' .
+--
+--
--
-- /See:/ 'streamDescription' smart constructor.
data StreamDescription = StreamDescription'
- { _sdStreamName :: !Text
- , _sdStreamARN :: !Text
- , _sdStreamStatus :: !StreamStatus
- , _sdShards :: ![Shard]
- , _sdHasMoreShards :: !Bool
- , _sdRetentionPeriodHours :: !Nat
- , _sdEnhancedMonitoring :: ![EnhancedMetrics]
+ { _sdStreamName :: !Text
+ , _sdStreamARN :: !Text
+ , _sdStreamStatus :: !StreamStatus
+ , _sdShards :: ![Shard]
+ , _sdHasMoreShards :: !Bool
+ , _sdRetentionPeriodHours :: !Nat
+ , _sdStreamCreationTimestamp :: !POSIX
+ , _sdEnhancedMonitoring :: ![EnhancedMetrics]
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'StreamDescription' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sdStreamName'
+-- * 'sdStreamName' - The name of the stream being described.
--
--- * 'sdStreamARN'
+-- * 'sdStreamARN' - The Amazon Resource Name (ARN) for the stream being described.
--
--- * 'sdStreamStatus'
+-- * 'sdStreamStatus' - The current status of the stream being described. The stream status is one of the following states: * @CREATING@ - The stream is being created. Amazon Kinesis immediately returns and sets @StreamStatus@ to @CREATING@ . * @DELETING@ - The stream is being deleted. The specified stream is in the @DELETING@ state until Amazon Kinesis completes the deletion. * @ACTIVE@ - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an @ACTIVE@ stream. * @UPDATING@ - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the @UPDATING@ state.
--
--- * 'sdShards'
+-- * 'sdShards' - The shards that comprise the stream.
--
--- * 'sdHasMoreShards'
+-- * 'sdHasMoreShards' - If set to @true@ , more shards in the stream are available to describe.
--
--- * 'sdRetentionPeriodHours'
+-- * 'sdRetentionPeriodHours' - The current retention period, in hours.
--
--- * 'sdEnhancedMonitoring'
+-- * 'sdStreamCreationTimestamp' - The approximate time that the stream was created.
+--
+-- * 'sdEnhancedMonitoring' - Represents the current enhanced monitoring settings of the stream.
streamDescription
:: Text -- ^ 'sdStreamName'
-> Text -- ^ 'sdStreamARN'
-> StreamStatus -- ^ 'sdStreamStatus'
-> Bool -- ^ 'sdHasMoreShards'
-> Natural -- ^ 'sdRetentionPeriodHours'
+ -> UTCTime -- ^ 'sdStreamCreationTimestamp'
-> StreamDescription
-streamDescription pStreamName_ pStreamARN_ pStreamStatus_ pHasMoreShards_ pRetentionPeriodHours_ =
+streamDescription pStreamName_ pStreamARN_ pStreamStatus_ pHasMoreShards_ pRetentionPeriodHours_ pStreamCreationTimestamp_ =
StreamDescription'
{ _sdStreamName = pStreamName_
, _sdStreamARN = pStreamARN_
@@ -515,6 +512,7 @@ streamDescription pStreamName_ pStreamARN_ pStreamStatus_ pHasMoreShards_ pReten
, _sdShards = mempty
, _sdHasMoreShards = pHasMoreShards_
, _sdRetentionPeriodHours = _Nat # pRetentionPeriodHours_
+ , _sdStreamCreationTimestamp = _Time # pStreamCreationTimestamp_
, _sdEnhancedMonitoring = mempty
}
@@ -526,12 +524,7 @@ sdStreamName = lens _sdStreamName (\ s a -> s{_sdStreamName = a});
sdStreamARN :: Lens' StreamDescription Text
sdStreamARN = lens _sdStreamARN (\ s a -> s{_sdStreamARN = a});
--- | The current status of the stream being described. The stream status is one of the following states:
---
--- - 'CREATING' - The stream is being created. Amazon Kinesis immediately returns and sets 'StreamStatus' to 'CREATING'.
--- - 'DELETING' - The stream is being deleted. The specified stream is in the 'DELETING' state until Amazon Kinesis completes the deletion.
--- - 'ACTIVE' - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an 'ACTIVE' stream.
--- - 'UPDATING' - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the 'UPDATING' state.
+-- | The current status of the stream being described. The stream status is one of the following states: * @CREATING@ - The stream is being created. Amazon Kinesis immediately returns and sets @StreamStatus@ to @CREATING@ . * @DELETING@ - The stream is being deleted. The specified stream is in the @DELETING@ state until Amazon Kinesis completes the deletion. * @ACTIVE@ - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an @ACTIVE@ stream. * @UPDATING@ - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the @UPDATING@ state.
sdStreamStatus :: Lens' StreamDescription StreamStatus
sdStreamStatus = lens _sdStreamStatus (\ s a -> s{_sdStreamStatus = a});
@@ -539,7 +532,7 @@ sdStreamStatus = lens _sdStreamStatus (\ s a -> s{_sdStreamStatus = a});
sdShards :: Lens' StreamDescription [Shard]
sdShards = lens _sdShards (\ s a -> s{_sdShards = a}) . _Coerce;
--- | If set to 'true', more shards in the stream are available to describe.
+-- | If set to @true@ , more shards in the stream are available to describe.
sdHasMoreShards :: Lens' StreamDescription Bool
sdHasMoreShards = lens _sdHasMoreShards (\ s a -> s{_sdHasMoreShards = a});
@@ -547,6 +540,10 @@ sdHasMoreShards = lens _sdHasMoreShards (\ s a -> s{_sdHasMoreShards = a});
sdRetentionPeriodHours :: Lens' StreamDescription Natural
sdRetentionPeriodHours = lens _sdRetentionPeriodHours (\ s a -> s{_sdRetentionPeriodHours = a}) . _Nat;
+-- | The approximate time that the stream was created.
+sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime
+sdStreamCreationTimestamp = lens _sdStreamCreationTimestamp (\ s a -> s{_sdStreamCreationTimestamp = a}) . _Time;
+
-- | Represents the current enhanced monitoring settings of the stream.
sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]
sdEnhancedMonitoring = lens _sdEnhancedMonitoring (\ s a -> s{_sdEnhancedMonitoring = a}) . _Coerce;
@@ -561,6 +558,7 @@ instance FromJSON StreamDescription where
<*> (x .:? "Shards" .!= mempty)
<*> (x .: "HasMoreShards")
<*> (x .: "RetentionPeriodHours")
+ <*> (x .: "StreamCreationTimestamp")
<*> (x .:? "EnhancedMonitoring" .!= mempty))
instance Hashable StreamDescription
@@ -569,6 +567,8 @@ instance NFData StreamDescription
-- | Metadata assigned to the stream, consisting of a key-value pair.
--
+--
+--
-- /See:/ 'tag' smart constructor.
data Tag = Tag'
{ _tagValue :: !(Maybe Text)
@@ -579,9 +579,9 @@ data Tag = Tag'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'tagValue'
+-- * 'tagValue' - An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
--
--- * 'tagKey'
+-- * 'tagKey' - A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
tag
:: Text -- ^ 'tagKey'
-> Tag
@@ -591,11 +591,11 @@ tag pKey_ =
, _tagKey = pKey_
}
--- | An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . \/ = + - % \'
+-- | An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
tagValue :: Lens' Tag (Maybe Text)
tagValue = lens _tagValue (\ s a -> s{_tagValue = a});
--- | A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . \/ = + - % \'
+-- | A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
tagKey :: Lens' Tag Text
tagKey = lens _tagKey (\ s a -> s{_tagKey = a});
diff --git a/gen/Network/AWS/Kinesis/Types/Sum.hs b/gen/Network/AWS/Kinesis/Types/Sum.hs
index 52c4037..7563961 100644
--- a/gen/Network/AWS/Kinesis/Types/Sum.hs
+++ b/gen/Network/AWS/Kinesis/Types/Sum.hs
@@ -66,6 +66,29 @@ instance ToJSON MetricsName where
instance FromJSON MetricsName where
parseJSON = parseJSONText "MetricsName"
+data ScalingType =
+ UniformScaling
+ deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic)
+
+instance FromText ScalingType where
+ parser = takeLowerText >>= \case
+ "uniform_scaling" -> pure UniformScaling
+ e -> fromTextError $ "Failure parsing ScalingType from value: '" <> e
+ <> "'. Accepted values: uniform_scaling"
+
+instance ToText ScalingType where
+ toText = \case
+ UniformScaling -> "UNIFORM_SCALING"
+
+instance Hashable ScalingType
+instance NFData ScalingType
+instance ToByteString ScalingType
+instance ToQuery ScalingType
+instance ToHeader ScalingType
+
+instance ToJSON ScalingType where
+ toJSON = toJSONText
+
data ShardIteratorType
= AfterSequenceNumber
| AtSequenceNumber
diff --git a/gen/Network/AWS/Kinesis/UpdateShardCount.hs b/gen/Network/AWS/Kinesis/UpdateShardCount.hs
new file mode 100644
index 0000000..4790a84
--- /dev/null
+++ b/gen/Network/AWS/Kinesis/UpdateShardCount.hs
@@ -0,0 +1,183 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE TypeFamilies #-}
+
+{-# OPTIONS_GHC -fno-warn-unused-imports #-}
+{-# OPTIONS_GHC -fno-warn-unused-binds #-}
+{-# OPTIONS_GHC -fno-warn-unused-matches #-}
+
+-- Derived from AWS service descriptions, licensed under Apache 2.0.
+
+-- |
+-- Module : Network.AWS.Kinesis.UpdateShardCount
+-- Copyright : (c) 2013-2016 Brendan Hay
+-- License : Mozilla Public License, v. 2.0.
+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>
+-- Stability : auto-generated
+-- Portability : non-portable (GHC extensions)
+--
+-- Updates the shard count of the specified stream to the specified number of shards.
+--
+--
+-- Updating the shard count is an asynchronous operation. Upon receiving the request, Amazon Kinesis returns immediately and sets the status of the stream to @UPDATING@ . After the update is complete, Amazon Kinesis sets the status of the stream back to @ACTIVE@ . Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is @UPDATING@ .
+--
+-- To update the shard count, Amazon Kinesis performs splits and merges and individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.
+--
+-- This operation has a rate limit of twice per rolling 24 hour period. You cannot scale above double your current shard count, scale below half your current shard count, or exceed the shard limits for your account.
+--
+-- For the default limits for an AWS account, see <http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits> in the /Amazon Kinesis Streams Developer Guide/ . If you need to increase a limit, <http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html contact AWS Support> .
+--
+module Network.AWS.Kinesis.UpdateShardCount
+ (
+ -- * Creating a Request
+ updateShardCount
+ , UpdateShardCount
+ -- * Request Lenses
+ , uscStreamName
+ , uscTargetShardCount
+ , uscScalingType
+
+ -- * Destructuring the Response
+ , updateShardCountResponse
+ , UpdateShardCountResponse
+ -- * Response Lenses
+ , uscrsTargetShardCount
+ , uscrsStreamName
+ , uscrsCurrentShardCount
+ , uscrsResponseStatus
+ ) where
+
+import Network.AWS.Kinesis.Types
+import Network.AWS.Kinesis.Types.Product
+import Network.AWS.Lens
+import Network.AWS.Prelude
+import Network.AWS.Request
+import Network.AWS.Response
+
+-- | /See:/ 'updateShardCount' smart constructor.
+data UpdateShardCount = UpdateShardCount'
+ { _uscStreamName :: !Text
+ , _uscTargetShardCount :: !Nat
+ , _uscScalingType :: !ScalingType
+ } deriving (Eq,Read,Show,Data,Typeable,Generic)
+
+-- | Creates a value of 'UpdateShardCount' with the minimum fields required to make a request.
+--
+-- Use one of the following lenses to modify other fields as desired:
+--
+-- * 'uscStreamName' - The name of the stream.
+--
+-- * 'uscTargetShardCount' - The new number of shards.
+--
+-- * 'uscScalingType' - The scaling type. Uniform scaling creates shards of equal size.
+updateShardCount
+ :: Text -- ^ 'uscStreamName'
+ -> Natural -- ^ 'uscTargetShardCount'
+ -> ScalingType -- ^ 'uscScalingType'
+ -> UpdateShardCount
+updateShardCount pStreamName_ pTargetShardCount_ pScalingType_ =
+ UpdateShardCount'
+ { _uscStreamName = pStreamName_
+ , _uscTargetShardCount = _Nat # pTargetShardCount_
+ , _uscScalingType = pScalingType_
+ }
+
+-- | The name of the stream.
+uscStreamName :: Lens' UpdateShardCount Text
+uscStreamName = lens _uscStreamName (\ s a -> s{_uscStreamName = a});
+
+-- | The new number of shards.
+uscTargetShardCount :: Lens' UpdateShardCount Natural
+uscTargetShardCount = lens _uscTargetShardCount (\ s a -> s{_uscTargetShardCount = a}) . _Nat;
+
+-- | The scaling type. Uniform scaling creates shards of equal size.
+uscScalingType :: Lens' UpdateShardCount ScalingType
+uscScalingType = lens _uscScalingType (\ s a -> s{_uscScalingType = a});
+
+instance AWSRequest UpdateShardCount where
+ type Rs UpdateShardCount = UpdateShardCountResponse
+ request = postJSON kinesis
+ response
+ = receiveJSON
+ (\ s h x ->
+ UpdateShardCountResponse' <$>
+ (x .?> "TargetShardCount") <*> (x .?> "StreamName")
+ <*> (x .?> "CurrentShardCount")
+ <*> (pure (fromEnum s)))
+
+instance Hashable UpdateShardCount
+
+instance NFData UpdateShardCount
+
+instance ToHeaders UpdateShardCount where
+ toHeaders
+ = const
+ (mconcat
+ ["X-Amz-Target" =#
+ ("Kinesis_20131202.UpdateShardCount" :: ByteString),
+ "Content-Type" =#
+ ("application/x-amz-json-1.1" :: ByteString)])
+
+instance ToJSON UpdateShardCount where
+ toJSON UpdateShardCount'{..}
+ = object
+ (catMaybes
+ [Just ("StreamName" .= _uscStreamName),
+ Just ("TargetShardCount" .= _uscTargetShardCount),
+ Just ("ScalingType" .= _uscScalingType)])
+
+instance ToPath UpdateShardCount where
+ toPath = const "/"
+
+instance ToQuery UpdateShardCount where
+ toQuery = const mempty
+
+-- | /See:/ 'updateShardCountResponse' smart constructor.
+data UpdateShardCountResponse = UpdateShardCountResponse'
+ { _uscrsTargetShardCount :: !(Maybe Nat)
+ , _uscrsStreamName :: !(Maybe Text)
+ , _uscrsCurrentShardCount :: !(Maybe Nat)
+ , _uscrsResponseStatus :: !Int
+ } deriving (Eq,Read,Show,Data,Typeable,Generic)
+
+-- | Creates a value of 'UpdateShardCountResponse' with the minimum fields required to make a request.
+--
+-- Use one of the following lenses to modify other fields as desired:
+--
+-- * 'uscrsTargetShardCount' - The updated number of shards.
+--
+-- * 'uscrsStreamName' - The name of the stream.
+--
+-- * 'uscrsCurrentShardCount' - The current number of shards.
+--
+-- * 'uscrsResponseStatus' - -- | The response status code.
+updateShardCountResponse
+ :: Int -- ^ 'uscrsResponseStatus'
+ -> UpdateShardCountResponse
+updateShardCountResponse pResponseStatus_ =
+ UpdateShardCountResponse'
+ { _uscrsTargetShardCount = Nothing
+ , _uscrsStreamName = Nothing
+ , _uscrsCurrentShardCount = Nothing
+ , _uscrsResponseStatus = pResponseStatus_
+ }
+
+-- | The updated number of shards.
+uscrsTargetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
+uscrsTargetShardCount = lens _uscrsTargetShardCount (\ s a -> s{_uscrsTargetShardCount = a}) . mapping _Nat;
+
+-- | The name of the stream.
+uscrsStreamName :: Lens' UpdateShardCountResponse (Maybe Text)
+uscrsStreamName = lens _uscrsStreamName (\ s a -> s{_uscrsStreamName = a});
+
+-- | The current number of shards.
+uscrsCurrentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
+uscrsCurrentShardCount = lens _uscrsCurrentShardCount (\ s a -> s{_uscrsCurrentShardCount = a}) . mapping _Nat;
+
+-- | -- | The response status code.
+uscrsResponseStatus :: Lens' UpdateShardCountResponse Int
+uscrsResponseStatus = lens _uscrsResponseStatus (\ s a -> s{_uscrsResponseStatus = a});
+
+instance NFData UpdateShardCountResponse
diff --git a/gen/Network/AWS/Kinesis/Waiters.hs b/gen/Network/AWS/Kinesis/Waiters.hs
index a1342c5..b7cf8ee 100644
--- a/gen/Network/AWS/Kinesis/Waiters.hs
+++ b/gen/Network/AWS/Kinesis/Waiters.hs
@@ -22,8 +22,7 @@ import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Waiter
--- | Polls 'Network.AWS.Kinesis.DescribeStream' every 10 seconds until a
--- successful state is reached. An error is returned after 18 failed checks.
+-- | Polls 'Network.AWS.Kinesis.DescribeStream' every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.
streamExists :: Wait DescribeStream
streamExists =
Wait
@@ -37,8 +36,7 @@ streamExists =
sdStreamStatus . to toTextCI)]
}
--- | Polls 'Network.AWS.Kinesis.DescribeStream' every 10 seconds until a
--- successful state is reached. An error is returned after 18 failed checks.
+-- | Polls 'Network.AWS.Kinesis.DescribeStream' every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.
streamNotExists :: Wait DescribeStream
streamNotExists =
Wait
diff --git a/test/Test/AWS/Gen/Kinesis.hs b/test/Test/AWS/Gen/Kinesis.hs
index 60a14c1..656932e 100644
--- a/test/Test/AWS/Gen/Kinesis.hs
+++ b/test/Test/AWS/Gen/Kinesis.hs
@@ -46,9 +46,15 @@ import Test.AWS.Kinesis.Internal
-- , requestEnableEnhancedMonitoring $
-- enableEnhancedMonitoring
--
+-- , requestDescribeLimits $
+-- describeLimits
+--
-- , requestDisableEnhancedMonitoring $
-- disableEnhancedMonitoring
--
+-- , requestUpdateShardCount $
+-- updateShardCount
+--
-- , requestListTagsForStream $
-- listTagsForStream
--
@@ -100,9 +106,15 @@ import Test.AWS.Kinesis.Internal
-- , responseEnableEnhancedMonitoring $
-- enhancedMonitoringOutput
--
+-- , responseDescribeLimits $
+-- describeLimitsResponse
+--
-- , responseDisableEnhancedMonitoring $
-- enhancedMonitoringOutput
--
+-- , responseUpdateShardCount $
+-- updateShardCountResponse
+--
-- , responseListTagsForStream $
-- listTagsForStreamResponse
--
@@ -168,11 +180,21 @@ requestEnableEnhancedMonitoring = req
"EnableEnhancedMonitoring"
"fixture/EnableEnhancedMonitoring.yaml"
+requestDescribeLimits :: DescribeLimits -> TestTree
+requestDescribeLimits = req
+ "DescribeLimits"
+ "fixture/DescribeLimits.yaml"
+
requestDisableEnhancedMonitoring :: DisableEnhancedMonitoring -> TestTree
requestDisableEnhancedMonitoring = req
"DisableEnhancedMonitoring"
"fixture/DisableEnhancedMonitoring.yaml"
+requestUpdateShardCount :: UpdateShardCount -> TestTree
+requestUpdateShardCount = req
+ "UpdateShardCount"
+ "fixture/UpdateShardCount.yaml"
+
requestListTagsForStream :: ListTagsForStream -> TestTree
requestListTagsForStream = req
"ListTagsForStream"
@@ -267,6 +289,13 @@ responseEnableEnhancedMonitoring = res
kinesis
(Proxy :: Proxy EnableEnhancedMonitoring)
+responseDescribeLimits :: DescribeLimitsResponse -> TestTree
+responseDescribeLimits = res
+ "DescribeLimitsResponse"
+ "fixture/DescribeLimitsResponse.proto"
+ kinesis
+ (Proxy :: Proxy DescribeLimits)
+
responseDisableEnhancedMonitoring :: EnhancedMonitoringOutput -> TestTree
responseDisableEnhancedMonitoring = res
"DisableEnhancedMonitoringResponse"
@@ -274,6 +303,13 @@ responseDisableEnhancedMonitoring = res
kinesis
(Proxy :: Proxy DisableEnhancedMonitoring)
+responseUpdateShardCount :: UpdateShardCountResponse -> TestTree
+responseUpdateShardCount = res
+ "UpdateShardCountResponse"
+ "fixture/UpdateShardCountResponse.proto"
+ kinesis
+ (Proxy :: Proxy UpdateShardCount)
+
responseListTagsForStream :: ListTagsForStreamResponse -> TestTree
responseListTagsForStream = res
"ListTagsForStreamResponse"