amazonka-kinesis-firehose 1.4.4 → 1.4.5

raw patch · 12 files changed

+336/−269 lines, 12 filesdep ~amazonka-coredep ~amazonka-kinesis-firehosedep ~amazonka-testPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

Dependency ranges changed: amazonka-core, amazonka-kinesis-firehose, amazonka-test

API changes (from Hackage documentation)

Files

• README.md +9/−8
• amazonka-kinesis-firehose.cabal +10/−13
• gen/Network/AWS/Firehose.hs +2/−1
• gen/Network/AWS/Firehose/CreateDeliveryStream.hs +26/−18
• gen/Network/AWS/Firehose/DeleteDeliveryStream.hs +14/−8
• gen/Network/AWS/Firehose/DescribeDeliveryStream.hs +15/−9
• gen/Network/AWS/Firehose/ListDeliveryStreams.hs +15/−9
• gen/Network/AWS/Firehose/PutRecord.hs +19/−13
• gen/Network/AWS/Firehose/PutRecordBatch.hs +21/−15
• gen/Network/AWS/Firehose/Types.hs +14/−2
• gen/Network/AWS/Firehose/Types/Product.hs +172/−160
• gen/Network/AWS/Firehose/UpdateDestination.hs +19/−13

@@ -8,26 +8,27 @@  ## Version -`1.4.4`+`1.4.5`   ## Description -Amazon Kinesis Firehose API Reference--Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.- Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-kinesis-firehose) 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.Firehose](http://hackage.haskell.org/package/amazonka-kinesis-firehose/docs/Network-AWS-Firehose.html)+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.+  ## Contribute 

@@ -1,5 +1,5 @@ name:                  amazonka-kinesis-firehose-version:               1.4.4+version:               1.4.5 synopsis:              Amazon Kinesis Firehose SDK. homepage:              https://github.com/brendanhay/amazonka bug-reports:           https://github.com/brendanhay/amazonka/issues@@ -13,22 +13,19 @@ cabal-version:         >= 1.10 extra-source-files:    README.md fixture/*.yaml fixture/*.proto src/.gitkeep description:-    Amazon Kinesis Firehose API Reference--    Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.-    .     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.Firehose" or <https://aws.amazon.com/documentation/ the AWS Documentation>+    See "Network.AWS.Firehose" or <https://aws.amazon.com/documentation/ the AWS documentation>     to get started.  source-repository head@@ -58,7 +55,7 @@         , Network.AWS.Firehose.Types.Sum      build-depends:-          amazonka-core == 1.4.4.*+          amazonka-core == 1.4.5.*         , base          >= 4.7     && < 5  test-suite amazonka-kinesis-firehose-test@@ -78,9 +75,9 @@         , Test.AWS.Firehose.Internal      build-depends:-          amazonka-core == 1.4.4.*-        , amazonka-test == 1.4.4.*-        , amazonka-kinesis-firehose == 1.4.4.*+          amazonka-core == 1.4.5.*+        , amazonka-test == 1.4.5.*+        , amazonka-kinesis-firehose == 1.4.5.*         , base         , bytestring         , tasty

@@ -11,9 +11,10 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Amazon Kinesis Firehose API Reference+-- __Amazon Kinesis Firehose API Reference__ -- -- Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.+-- module Network.AWS.Firehose     (     -- * Service Configuration

@@ -20,25 +20,29 @@ -- -- Creates a delivery stream. ----- < CreateDeliveryStream> is an asynchronous operation that immediately returns. The initial status of the delivery stream is 'CREATING'. After the delivery stream is created, its status is 'ACTIVE' and it now accepts data. Attempts to send data to a delivery stream that is not in the 'ACTIVE' state cause an exception. To check the state of a delivery stream, use < DescribeDeliveryStream>. ----- The name of a delivery stream identifies it. You can\'t have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name.+-- 'CreateDeliveryStream' is an asynchronous operation that immediately returns. The initial status of the delivery stream is @CREATING@ . After the delivery stream is created, its status is @ACTIVE@ and it now accepts data. Attempts to send data to a delivery stream that is not in the @ACTIVE@ state cause an exception. To check the state of a delivery stream, use 'DescribeDeliveryStream' . --+-- The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name.+-- -- By default, you can create up to 20 delivery streams per region. ----- A delivery stream can only be configured with a single destination, Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. For correct < CreateDeliveryStream> request syntax, specify only one destination configuration parameter: either __S3DestinationConfiguration__, __ElasticsearchDestinationConfiguration__, or __RedshiftDestinationConfiguration__.+-- A delivery stream can only be configured with a single destination, Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. For correct 'CreateDeliveryStream' request syntax, specify only one destination configuration parameter: either __S3DestinationConfiguration__ , __ElasticsearchDestinationConfiguration__ , or __RedshiftDestinationConfiguration__ . ----- As part of __S3DestinationConfiguration__, optional values __BufferingHints__, __EncryptionConfiguration__, and __CompressionFormat__ can be provided. By default, if no __BufferingHints__ value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that __BufferingHints__ is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.+-- As part of __S3DestinationConfiguration__ , optional values __BufferingHints__ , __EncryptionConfiguration__ , and __CompressionFormat__ can be provided. By default, if no __BufferingHints__ value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that __BufferingHints__ is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. ----- A few notes about __RedshiftDestinationConfiguration__:+-- A few notes about __RedshiftDestinationConfiguration__ : ----- -   An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses 'COPY' syntax to load data into an Amazon Redshift table. This is specified in the __RedshiftDestinationConfiguration.S3Configuration__ parameter element.+--     * An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses @COPY@ syntax to load data into an Amazon Redshift table. This is specified in the __RedshiftDestinationConfiguration.S3Configuration__ parameter element. ----- -   The compression formats 'SNAPPY' or 'ZIP' cannot be specified in __RedshiftDestinationConfiguration.S3Configuration__ because the Amazon Redshift 'COPY' operation that reads from the S3 bucket doesn\'t support these compression formats.+--     * The compression formats @SNAPPY@ or @ZIP@ cannot be specified in __RedshiftDestinationConfiguration.S3Configuration__ because the Amazon Redshift @COPY@ operation that reads from the S3 bucket doesn't support these compression formats. ----- -   We strongly recommend that the username and password provided is used exclusively for Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift 'INSERT' permissions.+--     * We strongly recommend that the username and password provided is used exclusively for Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift @INSERT@ permissions. ----- Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> in the /Amazon Kinesis Firehose Developer Guide/.+--+--+-- Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> in the /Amazon Kinesis Firehose Developer Guide/ .+-- module Network.AWS.Firehose.CreateDeliveryStream     (     -- * Creating a Request@@ -65,8 +69,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < CreateDeliveryStream>.+-- | Contains the parameters for 'CreateDeliveryStream' . --+--+-- -- /See:/ 'createDeliveryStream' smart constructor. data CreateDeliveryStream = CreateDeliveryStream'     { _cdsS3DestinationConfiguration            :: !(Maybe S3DestinationConfiguration)@@ -79,13 +85,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cdsS3DestinationConfiguration'+-- * 'cdsS3DestinationConfiguration' - The destination in Amazon S3. This value must be specified if __ElasticsearchDestinationConfiguration__ or __RedshiftDestinationConfiguration__ is specified (see restrictions listed above). ----- * 'cdsRedshiftDestinationConfiguration'+-- * 'cdsRedshiftDestinationConfiguration' - The destination in Amazon Redshift. This value cannot be specified if Amazon S3 or Amazon Elasticsearch is the desired destination (see restrictions listed above). ----- * 'cdsElasticsearchDestinationConfiguration'+-- * 'cdsElasticsearchDestinationConfiguration' - The destination in Amazon ES. This value cannot be specified if Amazon S3 or Amazon Redshift is the desired destination (see restrictions listed above). ----- * 'cdsDeliveryStreamName'+-- * 'cdsDeliveryStreamName' - The name of the delivery stream. createDeliveryStream     :: Text -- ^ 'cdsDeliveryStreamName'     -> CreateDeliveryStream@@ -156,8 +162,10 @@ instance ToQuery CreateDeliveryStream where         toQuery = const mempty --- | Contains the output of < CreateDeliveryStream>.+-- | Contains the output of 'CreateDeliveryStream' . --+--+-- -- /See:/ 'createDeliveryStreamResponse' smart constructor. data CreateDeliveryStreamResponse = CreateDeliveryStreamResponse'     { _cdsrsDeliveryStreamARN :: !(Maybe Text)@@ -168,9 +176,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cdsrsDeliveryStreamARN'+-- * 'cdsrsDeliveryStreamARN' - The ARN of the delivery stream. ----- * 'cdsrsResponseStatus'+-- * 'cdsrsResponseStatus' - -- | The response status code. createDeliveryStreamResponse     :: Int -- ^ 'cdsrsResponseStatus'     -> CreateDeliveryStreamResponse@@ -184,7 +192,7 @@ cdsrsDeliveryStreamARN :: Lens' CreateDeliveryStreamResponse (Maybe Text) cdsrsDeliveryStreamARN = lens _cdsrsDeliveryStreamARN (\ s a -> s{_cdsrsDeliveryStreamARN = a}); --- | The response status code.+-- | -- | The response status code. cdsrsResponseStatus :: Lens' CreateDeliveryStreamResponse Int cdsrsResponseStatus = lens _cdsrsResponseStatus (\ s a -> s{_cdsrsResponseStatus = a}); 

@@ -20,11 +20,13 @@ -- -- Deletes a delivery stream and its data. ----- You can delete a delivery stream only if it is in 'ACTIVE' or 'DELETING' state, and not in the 'CREATING' state. While the deletion request is in process, the delivery stream is in the 'DELETING' state. ----- To check the state of a delivery stream, use < DescribeDeliveryStream>.+-- You can delete a delivery stream only if it is in @ACTIVE@ or @DELETING@ state, and not in the @CREATING@ state. While the deletion request is in process, the delivery stream is in the @DELETING@ state. ----- While the delivery stream is 'DELETING' state, the service may continue to accept the records, but the service doesn\'t make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.+-- To check the state of a delivery stream, use 'DescribeDeliveryStream' .+--+-- While the delivery stream is @DELETING@ state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.+-- module Network.AWS.Firehose.DeleteDeliveryStream     (     -- * Creating a Request@@ -47,8 +49,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < DeleteDeliveryStream>.+-- | Contains the parameters for 'DeleteDeliveryStream' . --+--+-- -- /See:/ 'deleteDeliveryStream' smart constructor. newtype DeleteDeliveryStream = DeleteDeliveryStream'     { _dDeliveryStreamName :: Text@@ -58,7 +62,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dDeliveryStreamName'+-- * 'dDeliveryStreamName' - The name of the delivery stream. deleteDeliveryStream     :: Text -- ^ 'dDeliveryStreamName'     -> DeleteDeliveryStream@@ -108,8 +112,10 @@ instance ToQuery DeleteDeliveryStream where         toQuery = const mempty --- | Contains the output of < DeleteDeliveryStream>.+-- | Contains the output of 'DeleteDeliveryStream' . --+--+-- -- /See:/ 'deleteDeliveryStreamResponse' smart constructor. newtype DeleteDeliveryStreamResponse = DeleteDeliveryStreamResponse'     { _drsResponseStatus :: Int@@ -119,7 +125,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'drsResponseStatus'+-- * 'drsResponseStatus' - -- | The response status code. deleteDeliveryStreamResponse     :: Int -- ^ 'drsResponseStatus'     -> DeleteDeliveryStreamResponse@@ -128,7 +134,7 @@     { _drsResponseStatus = pResponseStatus_     } --- | The response status code.+-- | -- | The response status code. drsResponseStatus :: Lens' DeleteDeliveryStreamResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}); 

@@ -18,7 +18,9 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call < DescribeDeliveryStream> to see if the delivery stream is 'ACTIVE' and therefore ready for data to be sent to it.+-- Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call 'DescribeDeliveryStream' to see if the delivery stream is @ACTIVE@ and therefore ready for data to be sent to it.+--+-- module Network.AWS.Firehose.DescribeDeliveryStream     (     -- * Creating a Request@@ -44,8 +46,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < DescribeDeliveryStream>.+-- | Contains the parameters for 'DescribeDeliveryStream' . --+--+-- -- /See:/ 'describeDeliveryStream' smart constructor. data DescribeDeliveryStream = DescribeDeliveryStream'     { _ddsExclusiveStartDestinationId :: !(Maybe Text)@@ -57,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddsExclusiveStartDestinationId'+-- * 'ddsExclusiveStartDestinationId' - Specifies the destination ID to start returning the destination information. Currently Firehose supports one destination per delivery stream. ----- * 'ddsLimit'+-- * 'ddsLimit' - The limit on the number of destinations to return. Currently, you can have one destination per delivery stream. ----- * 'ddsDeliveryStreamName'+-- * 'ddsDeliveryStreamName' - The name of the delivery stream. describeDeliveryStream     :: Text -- ^ 'ddsDeliveryStreamName'     -> DescribeDeliveryStream@@ -125,8 +129,10 @@ instance ToQuery DescribeDeliveryStream where         toQuery = const mempty --- | Contains the output of < DescribeDeliveryStream>.+-- | Contains the output of 'DescribeDeliveryStream' . --+--+-- -- /See:/ 'describeDeliveryStreamResponse' smart constructor. data DescribeDeliveryStreamResponse = DescribeDeliveryStreamResponse'     { _ddsrsResponseStatus            :: !Int@@ -137,9 +143,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddsrsResponseStatus'+-- * 'ddsrsResponseStatus' - -- | The response status code. ----- * 'ddsrsDeliveryStreamDescription'+-- * 'ddsrsDeliveryStreamDescription' - Information about the delivery stream. describeDeliveryStreamResponse     :: Int -- ^ 'ddsrsResponseStatus'     -> DeliveryStreamDescription -- ^ 'ddsrsDeliveryStreamDescription'@@ -150,7 +156,7 @@     , _ddsrsDeliveryStreamDescription = pDeliveryStreamDescription_     } --- | The response status code.+-- | -- | The response status code. ddsrsResponseStatus :: Lens' DescribeDeliveryStreamResponse Int ddsrsResponseStatus = lens _ddsrsResponseStatus (\ s a -> s{_ddsrsResponseStatus = a}); 

@@ -20,7 +20,9 @@ -- -- Lists your delivery streams. ----- The number of delivery streams might be too large to return using a single call to < ListDeliveryStreams>. You can limit the number of delivery streams returned, using the __Limit__ parameter. To determine whether there are more delivery streams to list, check the value of __HasMoreDeliveryStreams__ in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the __ExclusiveStartDeliveryStreamName__ parameter of a subsequent call.+--+-- The number of delivery streams might be too large to return using a single call to 'ListDeliveryStreams' . You can limit the number of delivery streams returned, using the __Limit__ parameter. To determine whether there are more delivery streams to list, check the value of __HasMoreDeliveryStreams__ in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the __ExclusiveStartDeliveryStreamName__ parameter of a subsequent call.+-- module Network.AWS.Firehose.ListDeliveryStreams     (     -- * Creating a Request@@ -46,8 +48,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < ListDeliveryStreams>.+-- | Contains the parameters for 'ListDeliveryStreams' . --+--+-- -- /See:/ 'listDeliveryStreams' smart constructor. data ListDeliveryStreams = ListDeliveryStreams'     { _ldsLimit                            :: !(Maybe Nat)@@ -58,9 +62,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ldsLimit'+-- * 'ldsLimit' - The maximum number of delivery streams to list. ----- * 'ldsExclusiveStartDeliveryStreamName'+-- * 'ldsExclusiveStartDeliveryStreamName' - The name of the delivery stream to start the list with. listDeliveryStreams     :: ListDeliveryStreams listDeliveryStreams =@@ -117,8 +121,10 @@ instance ToQuery ListDeliveryStreams where         toQuery = const mempty --- | Contains the output of < ListDeliveryStreams>.+-- | Contains the output of 'ListDeliveryStreams' . --+--+-- -- /See:/ 'listDeliveryStreamsResponse' smart constructor. data ListDeliveryStreamsResponse = ListDeliveryStreamsResponse'     { _ldsrsResponseStatus         :: !Int@@ -130,11 +136,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ldsrsResponseStatus'+-- * 'ldsrsResponseStatus' - -- | The response status code. ----- * 'ldsrsDeliveryStreamNames'+-- * 'ldsrsDeliveryStreamNames' - The names of the delivery streams. ----- * 'ldsrsHasMoreDeliveryStreams'+-- * 'ldsrsHasMoreDeliveryStreams' - Indicates whether there are more delivery streams available to list. listDeliveryStreamsResponse     :: Int -- ^ 'ldsrsResponseStatus'     -> Bool -- ^ 'ldsrsHasMoreDeliveryStreams'@@ -146,7 +152,7 @@     , _ldsrsHasMoreDeliveryStreams = pHasMoreDeliveryStreams_     } --- | The response status code.+-- | -- | The response status code. ldsrsResponseStatus :: Lens' ListDeliveryStreamsResponse Int ldsrsResponseStatus = lens _ldsrsResponseStatus (\ s a -> s{_ldsrsResponseStatus = a}); 

@@ -18,19 +18,21 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use < PutRecordBatch>. Applications using these operations are referred to as producers.+-- Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use 'PutRecordBatch' . Applications using these operations are referred to as producers. ----- By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use < PutRecord> and < PutRecordBatch>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits>. ----- You must specify the name of the delivery stream and the data record when using < PutRecord>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc.+-- By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use 'PutRecord' and 'PutRecordBatch' , the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits> . ----- Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline ('\\n') or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.+-- You must specify the name of the delivery stream and the data record when using 'PutRecord' . The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc. ----- The < PutRecord> operation returns a __RecordId__, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.+-- Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (@\n@ ) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination. ----- If the < PutRecord> operation throws a __ServiceUnavailableException__, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.+-- The 'PutRecord' operation returns a __RecordId__ , which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. --+-- If the 'PutRecord' operation throws a __ServiceUnavailableException__ , back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.+-- -- Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.+-- module Network.AWS.Firehose.PutRecord     (     -- * Creating a Request@@ -55,8 +57,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < PutRecord>.+-- | Contains the parameters for 'PutRecord' . --+--+-- -- /See:/ 'putRecord' smart constructor. data PutRecord = PutRecord'     { _prDeliveryStreamName :: !Text@@ -67,9 +71,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'prDeliveryStreamName'+-- * 'prDeliveryStreamName' - The name of the delivery stream. ----- * 'prRecord'+-- * 'prRecord' - The record. putRecord     :: Text -- ^ 'prDeliveryStreamName'     -> Record -- ^ 'prRecord'@@ -124,8 +128,10 @@ instance ToQuery PutRecord where         toQuery = const mempty --- | Contains the output of < PutRecord>.+-- | Contains the output of 'PutRecord' . --+--+-- -- /See:/ 'putRecordResponse' smart constructor. data PutRecordResponse = PutRecordResponse'     { _prrsResponseStatus :: !Int@@ -136,9 +142,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'prrsResponseStatus'+-- * 'prrsResponseStatus' - -- | The response status code. ----- * 'prrsRecordId'+-- * 'prrsRecordId' - The ID of the record. putRecordResponse     :: Int -- ^ 'prrsResponseStatus'     -> Text -- ^ 'prrsRecordId'@@ -149,7 +155,7 @@     , _prrsRecordId = pRecordId_     } --- | The response status code.+-- | -- | The response status code. prrsResponseStatus :: Lens' PutRecordResponse Int prrsResponseStatus = lens _prrsResponseStatus (\ s a -> s{_prrsResponseStatus = a}); 

@@ -18,23 +18,25 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use < PutRecord>. Applications using these operations are referred to as producers.+-- Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use 'PutRecord' . Applications using these operations are referred to as producers. ----- Each < PutRecordBatch> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use < PutRecord> and < PutRecordBatch>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits>. ----- You must specify the name of the delivery stream and the data record when using < PutRecord>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.+-- Each 'PutRecordBatch' request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use 'PutRecord' and 'PutRecordBatch' , the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits> . ----- Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline ('\\n') or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.+-- You must specify the name of the delivery stream and the data record when using 'PutRecord' . The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on. ----- The < PutRecordBatch> response includes a count of any failed records, __FailedPutCount__, and an array of responses, __RequestResponses__. The __FailedPutCount__ value is a count of records that failed. Each entry in the __RequestResponses__ array gives additional information of the processed record. Each entry in __RequestResponses__ directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. __RequestResponses__ always includes the same number of records as the request array. __RequestResponses__ both successfully and unsuccessfully processed records. Firehose attempts to process all records in each < PutRecordBatch> request. A single record failure does not stop the processing of subsequent records.+-- Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (@\n@ ) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination. ----- A successfully processed record includes a __RecordId__ value, which is a unique value identified for the record. An unsuccessfully processed record includes __ErrorCode__ and __ErrorMessage__ values. __ErrorCode__ reflects the type of error and is one of the following values: 'ServiceUnavailable' or 'InternalFailure'. 'ErrorMessage' provides more detailed information about the error.+-- The 'PutRecordBatch' response includes a count of any failed records, __FailedPutCount__ , and an array of responses, __RequestResponses__ . The __FailedPutCount__ value is a count of records that failed. Each entry in the __RequestResponses__ array gives additional information of the processed record. Each entry in __RequestResponses__ directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. __RequestResponses__ always includes the same number of records as the request array. __RequestResponses__ both successfully and unsuccessfully processed records. Firehose attempts to process all records in each 'PutRecordBatch' request. A single record failure does not stop the processing of subsequent records. --+-- A successfully processed record includes a __RecordId__ value, which is a unique value identified for the record. An unsuccessfully processed record includes __ErrorCode__ and __ErrorMessage__ values. __ErrorCode__ reflects the type of error and is one of the following values: @ServiceUnavailable@ or @InternalFailure@ . @ErrorMessage@ provides more detailed information about the error.+-- -- If __FailedPutCount__ is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges). ----- If the < PutRecordBatch> operation throws a __ServiceUnavailableException__, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.+-- If the 'PutRecordBatch' operation throws a __ServiceUnavailableException__ , back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. -- -- Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.+-- module Network.AWS.Firehose.PutRecordBatch     (     -- * Creating a Request@@ -60,8 +62,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < PutRecordBatch>.+-- | Contains the parameters for 'PutRecordBatch' . --+--+-- -- /See:/ 'putRecordBatch' smart constructor. data PutRecordBatch = PutRecordBatch'     { _prbDeliveryStreamName :: !Text@@ -72,9 +76,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'prbDeliveryStreamName'+-- * 'prbDeliveryStreamName' - The name of the delivery stream. ----- * 'prbRecords'+-- * 'prbRecords' - One or more records. putRecordBatch     :: Text -- ^ 'prbDeliveryStreamName'     -> NonEmpty Record -- ^ 'prbRecords'@@ -130,8 +134,10 @@ instance ToQuery PutRecordBatch where         toQuery = const mempty --- | Contains the output of < PutRecordBatch>.+-- | Contains the output of 'PutRecordBatch' . --+--+-- -- /See:/ 'putRecordBatchResponse' smart constructor. data PutRecordBatchResponse = PutRecordBatchResponse'     { _prbrsResponseStatus   :: !Int@@ -143,11 +149,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'prbrsResponseStatus'+-- * 'prbrsResponseStatus' - -- | The response status code. ----- * 'prbrsFailedPutCount'+-- * 'prbrsFailedPutCount' - The number of unsuccessfully written records. ----- * 'prbrsRequestResponses'+-- * 'prbrsRequestResponses' - The results for the individual records. The index of each element matches the same index in which records were sent. putRecordBatchResponse     :: Int -- ^ 'prbrsResponseStatus'     -> Natural -- ^ 'prbrsFailedPutCount'@@ -160,7 +166,7 @@     , _prbrsRequestResponses = _List1 # pRequestResponses_     } --- | The response status code.+-- | -- | The response status code. prbrsResponseStatus :: Lens' PutRecordBatchResponse Int prbrsResponseStatus = lens _prbrsResponseStatus (\ s a -> s{_prbrsResponseStatus = a}); 

@@ -233,7 +233,7 @@ import           Network.AWS.Prelude import           Network.AWS.Sign.V4 --- | API version '2015-08-04' of the Amazon Kinesis Firehose SDK configuration.+-- | API version @2015-08-04@ of the Amazon Kinesis Firehose SDK configuration. firehose :: Service firehose =     Service@@ -268,28 +268,40 @@       | otherwise = Nothing  -- | The specified input parameter has an value that is not valid.+--+-- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidArgumentException = _ServiceError . hasCode "InvalidArgumentException"  -- | Another modification has already happened. Fetch __VersionId__ again and use it to update the destination.+--+-- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError _ConcurrentModificationException =     _ServiceError . hasCode "ConcurrentModificationException" --- | The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits>.+-- | The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see <http://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Firehose Limits> .+--+-- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError _ServiceUnavailableException =     _ServiceError . hasCode "ServiceUnavailableException"  -- | The specified resource could not be found.+--+-- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException =     _ServiceError . hasCode "ResourceNotFoundException"  -- | You have already reached the limit for a requested resource.+--+-- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _ServiceError . hasCode "LimitExceededException"  -- | The resource is already in use and not available for this operation.+--+-- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceInUseException = _ServiceError . hasCode "ResourceInUseException"

@@ -23,6 +23,8 @@  -- | Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Firehose may choose to use different values when it is optimal. --+--+-- -- /See:/ 'bufferingHints' smart constructor. data BufferingHints = BufferingHints'     { _bhSizeInMBs         :: !(Maybe Nat)@@ -33,9 +35,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'bhSizeInMBs'+-- * 'bhSizeInMBs' - Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher. ----- * 'bhIntervalInSeconds'+-- * 'bhIntervalInSeconds' - Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. bufferingHints     :: BufferingHints bufferingHints =@@ -44,9 +46,7 @@     , _bhIntervalInSeconds = Nothing     } --- | Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.------ We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB\/sec set SizeInMBs to be 10 MB or higher.+-- | Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher. bhSizeInMBs :: Lens' BufferingHints (Maybe Natural) bhSizeInMBs = lens _bhSizeInMBs (\ s a -> s{_bhSizeInMBs = a}) . mapping _Nat; @@ -74,6 +74,8 @@  -- | Describes CloudWatch logging options for your delivery stream. --+--+-- -- /See:/ 'cloudWatchLoggingOptions' smart constructor. data CloudWatchLoggingOptions = CloudWatchLoggingOptions'     { _cwloEnabled       :: !(Maybe Bool)@@ -85,11 +87,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cwloEnabled'+-- * 'cwloEnabled' - Enables or disables CloudWatch logging. ----- * 'cwloLogGroupName'+-- * 'cwloLogGroupName' - The CloudWatch group name for logging. This value is required if Enabled is true. ----- * 'cwloLogStreamName'+-- * 'cwloLogStreamName' - The CloudWatch log stream name for logging. This value is required if Enabled is true. cloudWatchLoggingOptions     :: CloudWatchLoggingOptions cloudWatchLoggingOptions =@@ -131,8 +133,10 @@                   ("LogGroupName" .=) <$> _cwloLogGroupName,                   ("LogStreamName" .=) <$> _cwloLogStreamName]) --- | Describes a 'COPY' command for Amazon Redshift.+-- | Describes a @COPY@ command for Amazon Redshift. --+--+-- -- /See:/ 'copyCommand' smart constructor. data CopyCommand = CopyCommand'     { _ccCopyOptions      :: !(Maybe Text)@@ -144,11 +148,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ccCopyOptions'+-- * 'ccCopyOptions' - Optional parameters to use with the Amazon Redshift @COPY@ command. For more information, see the "Optional Parameters" section of <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html Amazon Redshift COPY command> . Some possible examples that would apply to Firehose are as follows. @delimiter '\t' lzop;@ - fields are delimited with "\t" (TAB character) and compressed using lzop. @delimiter '|@ - fields are delimited with "|" (this is the default delimiter). @delimiter '|' escape@ - the delimiter should be escaped. @fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'@ - fields are fixed width in the source, with each width specified after every column in the table. @JSON 's3://mybucket/jsonpaths.txt'@ - data is in JSON format, and the path specified is the format of the data. For more examples, see <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html Amazon Redshift COPY command examples> . ----- * 'ccDataTableColumns'+-- * 'ccDataTableColumns' - A comma-separated list of column names. ----- * 'ccDataTableName'+-- * 'ccDataTableName' - The name of the target table. The table must already exist in the database. copyCommand     :: Text -- ^ 'ccDataTableName'     -> CopyCommand@@ -159,19 +163,7 @@     , _ccDataTableName = pDataTableName_     } --- | Optional parameters to use with the Amazon Redshift 'COPY' command. For more information, see the \"Optional Parameters\" section of <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html Amazon Redshift COPY command>. Some possible examples that would apply to Firehose are as follows.------ 'delimiter \'\\t\' lzop;' - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.------ 'delimiter \'|' - fields are delimited with \"|\" (this is the default delimiter).------ 'delimiter \'|\' escape' - the delimiter should be escaped.------ 'fixedwidth \'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6\'' - fields are fixed width in the source, with each width specified after every column in the table.------ 'JSON \'s3:\/\/mybucket\/jsonpaths.txt\'' - data is in JSON format, and the path specified is the format of the data.------ For more examples, see <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html Amazon Redshift COPY command examples>.+-- | Optional parameters to use with the Amazon Redshift @COPY@ command. For more information, see the "Optional Parameters" section of <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html Amazon Redshift COPY command> . Some possible examples that would apply to Firehose are as follows. @delimiter '\t' lzop;@ - fields are delimited with "\t" (TAB character) and compressed using lzop. @delimiter '|@ - fields are delimited with "|" (this is the default delimiter). @delimiter '|' escape@ - the delimiter should be escaped. @fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'@ - fields are fixed width in the source, with each width specified after every column in the table. @JSON 's3://mybucket/jsonpaths.txt'@ - data is in JSON format, and the path specified is the format of the data. For more examples, see <http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html Amazon Redshift COPY command examples> . ccCopyOptions :: Lens' CopyCommand (Maybe Text) ccCopyOptions = lens _ccCopyOptions (\ s a -> s{_ccCopyOptions = a}); @@ -205,6 +197,8 @@  -- | Contains information about a delivery stream. --+--+-- -- /See:/ 'deliveryStreamDescription' smart constructor. data DeliveryStreamDescription = DeliveryStreamDescription'     { _dsdCreateTimestamp      :: !(Maybe POSIX)@@ -221,21 +215,21 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsdCreateTimestamp'+-- * 'dsdCreateTimestamp' - The date and time that the delivery stream was created. ----- * 'dsdLastUpdateTimestamp'+-- * 'dsdLastUpdateTimestamp' - The date and time that the delivery stream was last updated. ----- * 'dsdDeliveryStreamName'+-- * 'dsdDeliveryStreamName' - The name of the delivery stream. ----- * 'dsdDeliveryStreamARN'+-- * 'dsdDeliveryStreamARN' - The Amazon Resource Name (ARN) of the delivery stream. ----- * 'dsdDeliveryStreamStatus'+-- * 'dsdDeliveryStreamStatus' - The status of the delivery stream. ----- * 'dsdVersionId'+-- * 'dsdVersionId' - Used when calling the 'UpdateDestination' operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream. ----- * 'dsdDestinations'+-- * 'dsdDestinations' - The destinations. ----- * 'dsdHasMoreDestinations'+-- * 'dsdHasMoreDestinations' - Indicates whether there are more destinations available to list. deliveryStreamDescription     :: Text -- ^ 'dsdDeliveryStreamName'     -> Text -- ^ 'dsdDeliveryStreamARN'@@ -275,7 +269,7 @@ dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus dsdDeliveryStreamStatus = lens _dsdDeliveryStreamStatus (\ s a -> s{_dsdDeliveryStreamStatus = a}); --- | Used when calling the < UpdateDestination> operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.+-- | Used when calling the 'UpdateDestination' operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream. dsdVersionId :: Lens' DeliveryStreamDescription Text dsdVersionId = lens _dsdVersionId (\ s a -> s{_dsdVersionId = a}); @@ -307,6 +301,8 @@  -- | Describes the destination for a delivery stream. --+--+-- -- /See:/ 'destinationDescription' smart constructor. data DestinationDescription = DestinationDescription'     { _ddS3DestinationDescription            :: !(Maybe S3DestinationDescription)@@ -319,13 +315,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddS3DestinationDescription'+-- * 'ddS3DestinationDescription' - The Amazon S3 destination. ----- * 'ddElasticsearchDestinationDescription'+-- * 'ddElasticsearchDestinationDescription' - The destination in Amazon ES. ----- * 'ddRedshiftDestinationDescription'+-- * 'ddRedshiftDestinationDescription' - The destination in Amazon Redshift. ----- * 'ddDestinationId'+-- * 'ddDestinationId' - The ID of the destination. destinationDescription     :: Text -- ^ 'ddDestinationId'     -> DestinationDescription@@ -369,6 +365,8 @@  -- | Describes the buffering to perform before delivering data to the Amazon ES destination. --+--+-- -- /See:/ 'elasticsearchBufferingHints' smart constructor. data ElasticsearchBufferingHints = ElasticsearchBufferingHints'     { _ebhSizeInMBs         :: !(Maybe Nat)@@ -379,9 +377,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ebhSizeInMBs'+-- * 'ebhSizeInMBs' - Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting __SizeInMBs__ to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, set __SizeInMBs__ to be 10 MB or higher. ----- * 'ebhIntervalInSeconds'+-- * 'ebhIntervalInSeconds' - Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). elasticsearchBufferingHints     :: ElasticsearchBufferingHints elasticsearchBufferingHints =@@ -390,9 +388,7 @@     , _ebhIntervalInSeconds = Nothing     } --- | Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.------ We recommend setting __SizeInMBs__ to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB\/sec, set __SizeInMBs__ to be 10 MB or higher.+-- | Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting __SizeInMBs__ to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, set __SizeInMBs__ to be 10 MB or higher. ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural) ebhSizeInMBs = lens _ebhSizeInMBs (\ s a -> s{_ebhSizeInMBs = a}) . mapping _Nat; @@ -420,6 +416,8 @@  -- | Describes the configuration of a destination in Amazon ES. --+--+-- -- /See:/ 'elasticsearchDestinationConfiguration' smart constructor. data ElasticsearchDestinationConfiguration = ElasticsearchDestinationConfiguration'     { _edcIndexRotationPeriod      :: !(Maybe ElasticsearchIndexRotationPeriod)@@ -438,25 +436,25 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'edcIndexRotationPeriod'+-- * 'edcIndexRotationPeriod' - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination> . Default value is @OneDay@ . ----- * 'edcS3BackupMode'+-- * 'edcS3BackupMode' - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup Amazon S3 Backup for Amazon Elasticsearch Service Destination> . Default value is FailedDocumentsOnly. ----- * 'edcCloudWatchLoggingOptions'+-- * 'edcCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'edcBufferingHints'+-- * 'edcBufferingHints' - Buffering options. If no value is specified, __ElasticsearchBufferingHints__ object default values are used. ----- * 'edcRetryOptions'+-- * 'edcRetryOptions' - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). ----- * 'edcRoleARN'+-- * 'edcRoleARN' - The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> . ----- * 'edcDomainARN'+-- * 'edcDomainARN' - The ARN of the Amazon ES domain. The IAM role must have permission for @DescribeElasticsearchDomain@ , @DescribeElasticsearchDomains@ , and @DescribeElasticsearchDomainConfig@ after assuming __RoleARN__ . ----- * 'edcIndexName'+-- * 'edcIndexName' - The Elasticsearch index name. ----- * 'edcTypeName'+-- * 'edcTypeName' - The Elasticsearch type name. ----- * 'edcS3Configuration'+-- * 'edcS3Configuration' - Undocumented member. elasticsearchDestinationConfiguration     :: Text -- ^ 'edcRoleARN'     -> Text -- ^ 'edcDomainARN'@@ -478,11 +476,11 @@     , _edcS3Configuration = pS3Configuration_     } --- | The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination>. Default value is 'OneDay'.+-- | The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination> . Default value is @OneDay@ . edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) edcIndexRotationPeriod = lens _edcIndexRotationPeriod (\ s a -> s{_edcIndexRotationPeriod = a}); --- | Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed\/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed\/ appended to the prefix. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup Amazon S3 Backup for Amazon Elasticsearch Service Destination>. Default value is FailedDocumentsOnly.+-- | Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup Amazon S3 Backup for Amazon Elasticsearch Service Destination> . Default value is FailedDocumentsOnly. edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) edcS3BackupMode = lens _edcS3BackupMode (\ s a -> s{_edcS3BackupMode = a}); @@ -498,11 +496,11 @@ edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) edcRetryOptions = lens _edcRetryOptions (\ s a -> s{_edcRetryOptions = a}); --- | The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access>.+-- | The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> . edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text edcRoleARN = lens _edcRoleARN (\ s a -> s{_edcRoleARN = a}); --- | The ARN of the Amazon ES domain. The IAM role must have permission for 'DescribeElasticsearchDomain', 'DescribeElasticsearchDomains' , and 'DescribeElasticsearchDomainConfig' after assuming __RoleARN__.+-- | The ARN of the Amazon ES domain. The IAM role must have permission for @DescribeElasticsearchDomain@ , @DescribeElasticsearchDomains@ , and @DescribeElasticsearchDomainConfig@ after assuming __RoleARN__ . edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text edcDomainARN = lens _edcDomainARN (\ s a -> s{_edcDomainARN = a}); @@ -543,6 +541,8 @@  -- | The destination description in Amazon ES. --+--+-- -- /See:/ 'elasticsearchDestinationDescription' smart constructor. data ElasticsearchDestinationDescription = ElasticsearchDestinationDescription'     { _eddIndexRotationPeriod      :: !(Maybe ElasticsearchIndexRotationPeriod)@@ -561,25 +561,25 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eddIndexRotationPeriod'+-- * 'eddIndexRotationPeriod' - The Elasticsearch index rotation period ----- * 'eddTypeName'+-- * 'eddTypeName' - The Elasticsearch type name. ----- * 'eddS3BackupMode'+-- * 'eddS3BackupMode' - Amazon S3 backup mode. ----- * 'eddDomainARN'+-- * 'eddDomainARN' - The ARN of the Amazon ES domain. ----- * 'eddCloudWatchLoggingOptions'+-- * 'eddCloudWatchLoggingOptions' - CloudWatch logging options. ----- * 'eddS3DestinationDescription'+-- * 'eddS3DestinationDescription' - Undocumented member. ----- * 'eddBufferingHints'+-- * 'eddBufferingHints' - Buffering options. ----- * 'eddRetryOptions'+-- * 'eddRetryOptions' - Elasticsearch retry options. ----- * 'eddRoleARN'+-- * 'eddRoleARN' - The ARN of the AWS credentials. ----- * 'eddIndexName'+-- * 'eddIndexName' - The Elasticsearch index name. elasticsearchDestinationDescription     :: ElasticsearchDestinationDescription elasticsearchDestinationDescription =@@ -658,6 +658,8 @@  -- | Describes an update for a destination in Amazon ES. --+--+-- -- /See:/ 'elasticsearchDestinationUpdate' smart constructor. data ElasticsearchDestinationUpdate = ElasticsearchDestinationUpdate'     { _eduIndexRotationPeriod      :: !(Maybe ElasticsearchIndexRotationPeriod)@@ -675,23 +677,23 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eduIndexRotationPeriod'+-- * 'eduIndexRotationPeriod' - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination> . Default value is @OneDay@ . ----- * 'eduTypeName'+-- * 'eduTypeName' - The Elasticsearch type name. ----- * 'eduDomainARN'+-- * 'eduDomainARN' - The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming __RoleARN__ . ----- * 'eduCloudWatchLoggingOptions'+-- * 'eduCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'eduS3Update'+-- * 'eduS3Update' - Undocumented member. ----- * 'eduBufferingHints'+-- * 'eduBufferingHints' - Buffering options. If no value is specified, __ElasticsearchBufferingHints__ object default values are used. ----- * 'eduRetryOptions'+-- * 'eduRetryOptions' - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). ----- * 'eduRoleARN'+-- * 'eduRoleARN' - The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> . ----- * 'eduIndexName'+-- * 'eduIndexName' - The Elasticsearch index name. elasticsearchDestinationUpdate     :: ElasticsearchDestinationUpdate elasticsearchDestinationUpdate =@@ -707,7 +709,7 @@     , _eduIndexName = Nothing     } --- | The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination>. Default value is 'OneDay'.+-- | The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation Index Rotation for Amazon Elasticsearch Service Destination> . Default value is @OneDay@ . eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) eduIndexRotationPeriod = lens _eduIndexRotationPeriod (\ s a -> s{_eduIndexRotationPeriod = a}); @@ -715,7 +717,7 @@ eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) eduTypeName = lens _eduTypeName (\ s a -> s{_eduTypeName = a}); --- | The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming __RoleARN__.+-- | The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming __RoleARN__ . eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) eduDomainARN = lens _eduDomainARN (\ s a -> s{_eduDomainARN = a}); @@ -735,7 +737,7 @@ eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) eduRetryOptions = lens _eduRetryOptions (\ s a -> s{_eduRetryOptions = a}); --- | The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access>.+-- | The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 Amazon S3 Bucket Access> . eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) eduRoleARN = lens _eduRoleARN (\ s a -> s{_eduRoleARN = a}); @@ -765,6 +767,8 @@  -- | Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. --+--+-- -- /See:/ 'elasticsearchRetryOptions' smart constructor. newtype ElasticsearchRetryOptions = ElasticsearchRetryOptions'     { _eroDurationInSeconds :: Maybe Nat@@ -774,7 +778,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eroDurationInSeconds'+-- * 'eroDurationInSeconds' - After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. elasticsearchRetryOptions     :: ElasticsearchRetryOptions elasticsearchRetryOptions =@@ -805,6 +809,8 @@  -- | Describes the encryption for a destination in Amazon S3. --+--+-- -- /See:/ 'encryptionConfiguration' smart constructor. data EncryptionConfiguration = EncryptionConfiguration'     { _ecNoEncryptionConfig  :: !(Maybe NoEncryptionConfig)@@ -815,9 +821,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ecNoEncryptionConfig'+-- * 'ecNoEncryptionConfig' - Specifically override existing encryption information to ensure no encryption is used. ----- * 'ecKMSEncryptionConfig'+-- * 'ecKMSEncryptionConfig' - The encryption key. encryptionConfiguration     :: EncryptionConfiguration encryptionConfiguration =@@ -856,6 +862,8 @@  -- | Describes an encryption key for a destination in Amazon S3. --+--+-- -- /See:/ 'kmsEncryptionConfig' smart constructor. newtype KMSEncryptionConfig = KMSEncryptionConfig'     { _kecAWSKMSKeyARN :: Text@@ -865,7 +873,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'kecAWSKMSKeyARN'+-- * 'kecAWSKMSKeyARN' - The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket. kmsEncryptionConfig     :: Text -- ^ 'kecAWSKMSKeyARN'     -> KMSEncryptionConfig@@ -894,8 +902,10 @@               (catMaybes                  [Just ("AWSKMSKeyARN" .= _kecAWSKMSKeyARN)]) --- | Contains the result for an individual record from a < PutRecordBatch> request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.+-- | Contains the result for an individual record from a 'PutRecordBatch' request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message. --+--+-- -- /See:/ 'putRecordBatchResponseEntry' smart constructor. data PutRecordBatchResponseEntry = PutRecordBatchResponseEntry'     { _prbreRecordId     :: !(Maybe Text)@@ -907,11 +917,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'prbreRecordId'+-- * 'prbreRecordId' - The ID of the record. ----- * 'prbreErrorCode'+-- * 'prbreErrorCode' - The error code for an individual record result. ----- * 'prbreErrorMessage'+-- * 'prbreErrorMessage' - The error message for an individual record result. putRecordBatchResponseEntry     :: PutRecordBatchResponseEntry putRecordBatchResponseEntry =@@ -947,6 +957,8 @@  -- | The unit of data in a delivery stream. --+--+-- -- /See:/ 'record' smart constructor. newtype Record = Record'     { _rData :: Base64@@ -956,7 +968,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rData'+-- * 'rData' - The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.-- /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. record     :: ByteString -- ^ 'rData'     -> Record@@ -965,13 +977,7 @@     { _rData = _Base64 # pData_     } --- | The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.------ /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, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.-- /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; @@ -985,6 +991,8 @@  -- | Describes the configuration of a destination in Amazon Redshift. --+--+-- -- /See:/ 'redshiftDestinationConfiguration' smart constructor. data RedshiftDestinationConfiguration = RedshiftDestinationConfiguration'     { _rdcCloudWatchLoggingOptions :: !(Maybe CloudWatchLoggingOptions)@@ -1001,21 +1009,21 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rdcCloudWatchLoggingOptions'+-- * 'rdcCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'rdcRetryOptions'+-- * 'rdcRetryOptions' - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). ----- * 'rdcRoleARN'+-- * 'rdcRoleARN' - The ARN of the AWS credentials. ----- * 'rdcClusterJDBCURL'+-- * 'rdcClusterJDBCURL' - The database connection string. ----- * 'rdcCopyCommand'+-- * 'rdcCopyCommand' - The @COPY@ command. ----- * 'rdcUsername'+-- * 'rdcUsername' - The name of the user. ----- * 'rdcPassword'+-- * 'rdcPassword' - The user password. ----- * 'rdcS3Configuration'+-- * 'rdcS3Configuration' - The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for 'CreateDeliveryStream' . The compression formats @SNAPPY@ or @ZIP@ cannot be specified in __RedshiftDestinationConfiguration.S3Configuration__ because the Amazon Redshift @COPY@ operation that reads from the S3 bucket doesn't support these compression formats. redshiftDestinationConfiguration     :: Text -- ^ 'rdcRoleARN'     -> Text -- ^ 'rdcClusterJDBCURL'@@ -1052,7 +1060,7 @@ rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text rdcClusterJDBCURL = lens _rdcClusterJDBCURL (\ s a -> s{_rdcClusterJDBCURL = a}); --- | The 'COPY' command.+-- | The @COPY@ command. rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand rdcCopyCommand = lens _rdcCopyCommand (\ s a -> s{_rdcCopyCommand = a}); @@ -1064,9 +1072,7 @@ rdcPassword :: Lens' RedshiftDestinationConfiguration Text rdcPassword = lens _rdcPassword (\ s a -> s{_rdcPassword = a}) . _Sensitive; --- | The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for < CreateDeliveryStream>.------ The compression formats 'SNAPPY' or 'ZIP' cannot be specified in __RedshiftDestinationConfiguration.S3Configuration__ because the Amazon Redshift 'COPY' operation that reads from the S3 bucket doesn\'t support these compression formats.+-- | The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for 'CreateDeliveryStream' . The compression formats @SNAPPY@ or @ZIP@ cannot be specified in __RedshiftDestinationConfiguration.S3Configuration__ because the Amazon Redshift @COPY@ operation that reads from the S3 bucket doesn't support these compression formats. rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration rdcS3Configuration = lens _rdcS3Configuration (\ s a -> s{_rdcS3Configuration = a}); @@ -1091,6 +1097,8 @@  -- | Describes a destination in Amazon Redshift. --+--+-- -- /See:/ 'redshiftDestinationDescription' smart constructor. data RedshiftDestinationDescription = RedshiftDestinationDescription'     { _rddCloudWatchLoggingOptions :: !(Maybe CloudWatchLoggingOptions)@@ -1106,19 +1114,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rddCloudWatchLoggingOptions'+-- * 'rddCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'rddRetryOptions'+-- * 'rddRetryOptions' - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). ----- * 'rddRoleARN'+-- * 'rddRoleARN' - The ARN of the AWS credentials. ----- * 'rddClusterJDBCURL'+-- * 'rddClusterJDBCURL' - The database connection string. ----- * 'rddCopyCommand'+-- * 'rddCopyCommand' - The @COPY@ command. ----- * 'rddUsername'+-- * 'rddUsername' - The name of the user. ----- * 'rddS3DestinationDescription'+-- * 'rddS3DestinationDescription' - The Amazon S3 destination. redshiftDestinationDescription     :: Text -- ^ 'rddRoleARN'     -> Text -- ^ 'rddClusterJDBCURL'@@ -1153,7 +1161,7 @@ rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text rddClusterJDBCURL = lens _rddClusterJDBCURL (\ s a -> s{_rddClusterJDBCURL = a}); --- | The 'COPY' command.+-- | The @COPY@ command. rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand rddCopyCommand = lens _rddCopyCommand (\ s a -> s{_rddCopyCommand = a}); @@ -1185,6 +1193,8 @@  -- | Describes an update for a destination in Amazon Redshift. --+--+-- -- /See:/ 'redshiftDestinationUpdate' smart constructor. data RedshiftDestinationUpdate = RedshiftDestinationUpdate'     { _rduCloudWatchLoggingOptions :: !(Maybe CloudWatchLoggingOptions)@@ -1201,21 +1211,21 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rduCloudWatchLoggingOptions'+-- * 'rduCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'rduUsername'+-- * 'rduUsername' - The name of the user. ----- * 'rduS3Update'+-- * 'rduS3Update' - The Amazon S3 destination. The compression formats @SNAPPY@ or @ZIP@ cannot be specified in __RedshiftDestinationUpdate.S3Update__ because the Amazon Redshift @COPY@ operation that reads from the S3 bucket doesn't support these compression formats. ----- * 'rduPassword'+-- * 'rduPassword' - The user password. ----- * 'rduCopyCommand'+-- * 'rduCopyCommand' - The @COPY@ command. ----- * 'rduRetryOptions'+-- * 'rduRetryOptions' - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). ----- * 'rduClusterJDBCURL'+-- * 'rduClusterJDBCURL' - The database connection string. ----- * 'rduRoleARN'+-- * 'rduRoleARN' - The ARN of the AWS credentials. redshiftDestinationUpdate     :: RedshiftDestinationUpdate redshiftDestinationUpdate =@@ -1238,9 +1248,7 @@ rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text) rduUsername = lens _rduUsername (\ s a -> s{_rduUsername = a}) . mapping _Sensitive; --- | The Amazon S3 destination.------ The compression formats 'SNAPPY' or 'ZIP' cannot be specified in __RedshiftDestinationUpdate.S3Update__ because the Amazon Redshift 'COPY' operation that reads from the S3 bucket doesn\'t support these compression formats.+-- | The Amazon S3 destination. The compression formats @SNAPPY@ or @ZIP@ cannot be specified in __RedshiftDestinationUpdate.S3Update__ because the Amazon Redshift @COPY@ operation that reads from the S3 bucket doesn't support these compression formats. rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) rduS3Update = lens _rduS3Update (\ s a -> s{_rduS3Update = a}); @@ -1248,7 +1256,7 @@ rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text) rduPassword = lens _rduPassword (\ s a -> s{_rduPassword = a}) . mapping _Sensitive; --- | The 'COPY' command.+-- | The @COPY@ command. rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) rduCopyCommand = lens _rduCopyCommand (\ s a -> s{_rduCopyCommand = a}); @@ -1284,6 +1292,8 @@  -- | Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. --+--+-- -- /See:/ 'redshiftRetryOptions' smart constructor. newtype RedshiftRetryOptions = RedshiftRetryOptions'     { _rroDurationInSeconds :: Maybe Nat@@ -1293,7 +1303,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rroDurationInSeconds'+-- * 'rroDurationInSeconds' - The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of @DurationInSeconds@ is 0 (zero) or if the first delivery attempt takes longer than the current value. redshiftRetryOptions     :: RedshiftRetryOptions redshiftRetryOptions =@@ -1301,7 +1311,7 @@     { _rroDurationInSeconds = Nothing     } --- | The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of 'DurationInSeconds' is 0 (zero) or if the first delivery attempt takes longer than the current value.+-- | The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of @DurationInSeconds@ is 0 (zero) or if the first delivery attempt takes longer than the current value. rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural) rroDurationInSeconds = lens _rroDurationInSeconds (\ s a -> s{_rroDurationInSeconds = a}) . mapping _Nat; @@ -1324,6 +1334,8 @@  -- | Describes the configuration of a destination in Amazon S3. --+--+-- -- /See:/ 's3DestinationConfiguration' smart constructor. data S3DestinationConfiguration = S3DestinationConfiguration'     { _sdcPrefix                   :: !(Maybe Text)@@ -1339,19 +1351,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'sdcPrefix'+-- * 'sdcPrefix' - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . ----- * 'sdcCloudWatchLoggingOptions'+-- * 'sdcCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'sdcEncryptionConfiguration'+-- * 'sdcEncryptionConfiguration' - The encryption configuration. If no value is specified, the default is no encryption. ----- * 'sdcCompressionFormat'+-- * 'sdcCompressionFormat' - The compression format. If no value is specified, the default is @UNCOMPRESSED@ . The compression formats @SNAPPY@ or @ZIP@ cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift @COPY@ operation that reads from the S3 bucket. ----- * 'sdcBufferingHints'+-- * 'sdcBufferingHints' - The buffering option. If no value is specified, __BufferingHints__ object default values are used. ----- * 'sdcRoleARN'+-- * 'sdcRoleARN' - The ARN of the AWS credentials. ----- * 'sdcBucketARN'+-- * 'sdcBucketARN' - The ARN of the S3 bucket. s3DestinationConfiguration     :: Text -- ^ 'sdcRoleARN'     -> Text -- ^ 'sdcBucketARN'@@ -1367,7 +1379,7 @@     , _sdcBucketARN = pBucketARN_     } --- | The \"YYYY\/MM\/DD\/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide>.+-- | The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text) sdcPrefix = lens _sdcPrefix (\ s a -> s{_sdcPrefix = a}); @@ -1379,9 +1391,7 @@ sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) sdcEncryptionConfiguration = lens _sdcEncryptionConfiguration (\ s a -> s{_sdcEncryptionConfiguration = a}); --- | The compression format. If no value is specified, the default is 'UNCOMPRESSED'.------ The compression formats 'SNAPPY' or 'ZIP' cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift 'COPY' operation that reads from the S3 bucket.+-- | The compression format. If no value is specified, the default is @UNCOMPRESSED@ . The compression formats @SNAPPY@ or @ZIP@ cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift @COPY@ operation that reads from the S3 bucket. sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) sdcCompressionFormat = lens _sdcCompressionFormat (\ s a -> s{_sdcCompressionFormat = a}); @@ -1417,6 +1427,8 @@  -- | Describes a destination in Amazon S3. --+--+-- -- /See:/ 's3DestinationDescription' smart constructor. data S3DestinationDescription = S3DestinationDescription'     { _sddPrefix                   :: !(Maybe Text)@@ -1432,19 +1444,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'sddPrefix'+-- * 'sddPrefix' - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . ----- * 'sddCloudWatchLoggingOptions'+-- * 'sddCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'sddRoleARN'+-- * 'sddRoleARN' - The ARN of the AWS credentials. ----- * 'sddBucketARN'+-- * 'sddBucketARN' - The ARN of the S3 bucket. ----- * 'sddBufferingHints'+-- * 'sddBufferingHints' - The buffering option. If no value is specified, __BufferingHints__ object default values are used. ----- * 'sddCompressionFormat'+-- * 'sddCompressionFormat' - The compression format. If no value is specified, the default is @NOCOMPRESSION@ . ----- * 'sddEncryptionConfiguration'+-- * 'sddEncryptionConfiguration' - The encryption configuration. If no value is specified, the default is no encryption. s3DestinationDescription     :: Text -- ^ 'sddRoleARN'     -> Text -- ^ 'sddBucketARN'@@ -1463,7 +1475,7 @@     , _sddEncryptionConfiguration = pEncryptionConfiguration_     } --- | The \"YYYY\/MM\/DD\/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide>.+-- | The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . sddPrefix :: Lens' S3DestinationDescription (Maybe Text) sddPrefix = lens _sddPrefix (\ s a -> s{_sddPrefix = a}); @@ -1483,7 +1495,7 @@ sddBufferingHints :: Lens' S3DestinationDescription BufferingHints sddBufferingHints = lens _sddBufferingHints (\ s a -> s{_sddBufferingHints = a}); --- | The compression format. If no value is specified, the default is 'NOCOMPRESSION'.+-- | The compression format. If no value is specified, the default is @NOCOMPRESSION@ . sddCompressionFormat :: Lens' S3DestinationDescription CompressionFormat sddCompressionFormat = lens _sddCompressionFormat (\ s a -> s{_sddCompressionFormat = a}); @@ -1510,6 +1522,8 @@  -- | Describes an update for a destination in Amazon S3. --+--+-- -- /See:/ 's3DestinationUpdate' smart constructor. data S3DestinationUpdate = S3DestinationUpdate'     { _sduPrefix                   :: !(Maybe Text)@@ -1525,19 +1539,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'sduPrefix'+-- * 'sduPrefix' - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . ----- * 'sduCloudWatchLoggingOptions'+-- * 'sduCloudWatchLoggingOptions' - Describes CloudWatch logging options for your delivery stream. ----- * 'sduEncryptionConfiguration'+-- * 'sduEncryptionConfiguration' - The encryption configuration. If no value is specified, the default is no encryption. ----- * 'sduCompressionFormat'+-- * 'sduCompressionFormat' - The compression format. If no value is specified, the default is @NOCOMPRESSION@ . The compression formats @SNAPPY@ or @ZIP@ cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift @COPY@ operation that reads from the S3 bucket. ----- * 'sduBufferingHints'+-- * 'sduBufferingHints' - The buffering option. If no value is specified, __BufferingHints__ object default values are used. ----- * 'sduBucketARN'+-- * 'sduBucketARN' - The ARN of the S3 bucket. ----- * 'sduRoleARN'+-- * 'sduRoleARN' - The ARN of the AWS credentials. s3DestinationUpdate     :: S3DestinationUpdate s3DestinationUpdate =@@ -1551,7 +1565,7 @@     , _sduRoleARN = Nothing     } --- | The \"YYYY\/MM\/DD\/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide>.+-- | The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html Amazon S3 Object Name Format> in the <http://docs.aws.amazon.com/firehose/latest/dev/ Amazon Kinesis Firehose Developer Guide> . sduPrefix :: Lens' S3DestinationUpdate (Maybe Text) sduPrefix = lens _sduPrefix (\ s a -> s{_sduPrefix = a}); @@ -1563,9 +1577,7 @@ sduEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) sduEncryptionConfiguration = lens _sduEncryptionConfiguration (\ s a -> s{_sduEncryptionConfiguration = a}); --- | The compression format. If no value is specified, the default is 'NOCOMPRESSION'.------ The compression formats 'SNAPPY' or 'ZIP' cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift 'COPY' operation that reads from the S3 bucket.+-- | The compression format. If no value is specified, the default is @NOCOMPRESSION@ . The compression formats @SNAPPY@ or @ZIP@ cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift @COPY@ operation that reads from the S3 bucket. sduCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat) sduCompressionFormat = lens _sduCompressionFormat (\ s a -> s{_sduCompressionFormat = a}); 

@@ -20,13 +20,15 @@ -- -- Updates the specified destination of the specified delivery stream. Note: Switching between Elasticsearch and other services is not supported. For Elasticsearch destination, you can only update an existing Elasticsearch destination with this operation. --+-- -- This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are normally effective within a few minutes. ----- If the destination type is the same, Firehose merges the configuration parameters specified in the < UpdateDestination> request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if < EncryptionConfiguration> is not specified then the existing < EncryptionConfiguration> is maintained on the destination.+-- If the destination type is the same, Firehose merges the configuration parameters specified in the 'UpdateDestination' request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if 'EncryptionConfiguration' is not specified then the existing 'EncryptionConfiguration' is maintained on the destination. -- -- If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified. ----- Firehose uses the __CurrentDeliveryStreamVersionId__ to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the __VersionId__. After the update is applied successfully, the __VersionId__ is updated, which can be retrieved with the < DescribeDeliveryStream> operation. The new __VersionId__ should be uses to set __CurrentDeliveryStreamVersionId__ in the next < UpdateDestination> operation.+-- Firehose uses the __CurrentDeliveryStreamVersionId__ to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the __VersionId__ . After the update is applied successfully, the __VersionId__ is updated, which can be retrieved with the 'DescribeDeliveryStream' operation. The new __VersionId__ should be uses to set __CurrentDeliveryStreamVersionId__ in the next 'UpdateDestination' operation.+-- module Network.AWS.Firehose.UpdateDestination     (     -- * Creating a Request@@ -54,8 +56,10 @@ import           Network.AWS.Request import           Network.AWS.Response --- | Contains the parameters for < UpdateDestination>.+-- | Contains the parameters for 'UpdateDestination' . --+--+-- -- /See:/ 'updateDestination' smart constructor. data UpdateDestination = UpdateDestination'     { _udS3DestinationUpdate            :: !(Maybe S3DestinationUpdate)@@ -70,17 +74,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'udS3DestinationUpdate'+-- * 'udS3DestinationUpdate' - Describes an update for a destination in Amazon S3. ----- * 'udRedshiftDestinationUpdate'+-- * 'udRedshiftDestinationUpdate' - Describes an update for a destination in Amazon Redshift. ----- * 'udElasticsearchDestinationUpdate'+-- * 'udElasticsearchDestinationUpdate' - Describes an update for a destination in Amazon ES. ----- * 'udDeliveryStreamName'+-- * 'udDeliveryStreamName' - The name of the delivery stream. ----- * 'udCurrentDeliveryStreamVersionId'+-- * 'udCurrentDeliveryStreamVersionId' - Obtain this value from the __VersionId__ result of the 'DeliveryStreamDescription' operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the __VersionId__ value is updated. The service then performs a merge of the old configuration with the new configuration. ----- * 'udDestinationId'+-- * 'udDestinationId' - The ID of the destination. updateDestination     :: Text -- ^ 'udDeliveryStreamName'     -> Text -- ^ 'udCurrentDeliveryStreamVersionId'@@ -112,7 +116,7 @@ udDeliveryStreamName :: Lens' UpdateDestination Text udDeliveryStreamName = lens _udDeliveryStreamName (\ s a -> s{_udDeliveryStreamName = a}); --- | Obtain this value from the __VersionId__ result of the < DeliveryStreamDescription> operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the __VersionId__ value is updated. The service then performs a merge of the old configuration with the new configuration.+-- | Obtain this value from the __VersionId__ result of the 'DeliveryStreamDescription' operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the __VersionId__ value is updated. The service then performs a merge of the old configuration with the new configuration. udCurrentDeliveryStreamVersionId :: Lens' UpdateDestination Text udCurrentDeliveryStreamVersionId = lens _udCurrentDeliveryStreamVersionId (\ s a -> s{_udCurrentDeliveryStreamVersionId = a}); @@ -164,8 +168,10 @@ instance ToQuery UpdateDestination where         toQuery = const mempty --- | Contains the output of < UpdateDestination>.+-- | Contains the output of 'UpdateDestination' . --+--+-- -- /See:/ 'updateDestinationResponse' smart constructor. newtype UpdateDestinationResponse = UpdateDestinationResponse'     { _udrsResponseStatus :: Int@@ -175,7 +181,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'udrsResponseStatus'+-- * 'udrsResponseStatus' - -- | The response status code. updateDestinationResponse     :: Int -- ^ 'udrsResponseStatus'     -> UpdateDestinationResponse@@ -184,7 +190,7 @@     { _udrsResponseStatus = pResponseStatus_     } --- | The response status code.+-- | -- | The response status code. udrsResponseStatus :: Lens' UpdateDestinationResponse Int udrsResponseStatus = lens _udrsResponseStatus (\ s a -> s{_udrsResponseStatus = a});