packages feed

amazonka-kinesis-firehose 1.4.2 → 1.4.3

raw patch · 13 files changed

+145/−432 lines, 13 filesdep ~amazonka-coredep ~amazonka-kinesis-firehosedep ~amazonka-testPVP ok

version bump matches the API change (PVP)

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

API changes (from Hackage documentation)

Files

README.md view
@@ -8,17 +8,14 @@  ## Version -`1.4.2`+`1.4.3`   ## 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.+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/).
amazonka-kinesis-firehose.cabal view
@@ -1,5 +1,5 @@ name:                  amazonka-kinesis-firehose-version:               1.4.2+version:               1.4.3 synopsis:              Amazon Kinesis Firehose SDK. homepage:              https://github.com/brendanhay/amazonka bug-reports:           https://github.com/brendanhay/amazonka/issues@@ -15,10 +15,7 @@ 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.+    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@@ -61,7 +58,7 @@         , Network.AWS.Firehose.Types.Sum      build-depends:-          amazonka-core == 1.4.2.*+          amazonka-core == 1.4.3.*         , base          >= 4.7     && < 5  test-suite amazonka-kinesis-firehose-test@@ -81,9 +78,9 @@         , Test.AWS.Firehose.Internal      build-depends:-          amazonka-core == 1.4.2.*-        , amazonka-test == 1.4.2.*-        , amazonka-kinesis-firehose == 1.4.2.*+          amazonka-core == 1.4.3.*+        , amazonka-test == 1.4.3.*+        , amazonka-kinesis-firehose == 1.4.3.*         , base         , bytestring         , tasty
gen/Network/AWS/Firehose.hs view
@@ -13,10 +13,7 @@ -- -- 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.+-- 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
gen/Network/AWS/Firehose/CreateDeliveryStream.hs view
@@ -20,59 +20,23 @@ -- -- 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>.+-- < 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.+-- 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 or Amazon Redshift. For correct < CreateDeliveryStream>--- request syntax, specify only one destination configuration parameter:--- either __ElasticsearchDestinationConfiguration__,--- __RedshiftDestinationConfiguration__ or __S3DestinationConfiguration__+-- A delivery stream can only be configured with a single destination, Amazon S3 or Amazon Redshift. For correct < CreateDeliveryStream> request syntax, specify only one destination configuration parameter: either __ElasticsearchDestinationConfiguration__, __RedshiftDestinationConfiguration__ or __S3DestinationConfiguration__ ----- 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__: ----- -   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.--- -   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.+-- -   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.+-- -   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@@ -131,22 +95,15 @@     , _cdsDeliveryStreamName = pDeliveryStreamName_     } --- | The destination in Amazon S3. This value must be specified if--- __ElasticsearchDestinationConfiguration__ or--- __RedshiftDestinationConfiguration__ is specified (see restrictions--- listed above).+-- | The destination in Amazon S3. This value must be specified if __ElasticsearchDestinationConfiguration__ or __RedshiftDestinationConfiguration__ is specified (see restrictions listed above). cdsS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe S3DestinationConfiguration) cdsS3DestinationConfiguration = lens _cdsS3DestinationConfiguration (\ s a -> s{_cdsS3DestinationConfiguration = a}); --- | The destination in Amazon Redshift. This value cannot be specified if--- Amazon S3 or Amazon Elasticsearch is the desired destination (see--- restrictions listed above).+-- | The destination in Amazon Redshift. This value cannot be specified if Amazon S3 or Amazon Elasticsearch is the desired destination (see restrictions listed above). cdsRedshiftDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe RedshiftDestinationConfiguration) cdsRedshiftDestinationConfiguration = lens _cdsRedshiftDestinationConfiguration (\ s a -> s{_cdsRedshiftDestinationConfiguration = a}); --- | The destination in Amazon ES. This value cannot be specified if Amazon--- S3 or Amazon Redshift is the desired destination (see restrictions--- listed above).+-- | The destination in Amazon ES. This value cannot be specified if Amazon S3 or Amazon Redshift is the desired destination (see restrictions listed above). cdsElasticsearchDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ElasticsearchDestinationConfiguration) cdsElasticsearchDestinationConfiguration = lens _cdsElasticsearchDestinationConfiguration (\ s a -> s{_cdsElasticsearchDestinationConfiguration = a});
gen/Network/AWS/Firehose/DeleteDeliveryStream.hs view
@@ -20,17 +20,11 @@ -- -- 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.+-- 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>. ----- 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.+-- 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
gen/Network/AWS/Firehose/DescribeDeliveryStream.hs view
@@ -18,10 +18,7 @@ -- 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@@ -75,14 +72,11 @@     , _ddsDeliveryStreamName = pDeliveryStreamName_     } --- | Specifies the destination ID to start returning the destination--- information. Currently Firehose supports one destination per delivery--- stream.+-- | Specifies the destination ID to start returning the destination information. Currently Firehose supports one destination per delivery stream. ddsExclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text) ddsExclusiveStartDestinationId = lens _ddsExclusiveStartDestinationId (\ s a -> s{_ddsExclusiveStartDestinationId = a}); --- | The limit on the number of destinations to return. Currently, you can--- have one destination per delivery stream.+-- | The limit on the number of destinations to return. Currently, you can have one destination per delivery stream. ddsLimit :: Lens' DescribeDeliveryStream (Maybe Natural) ddsLimit = lens _ddsLimit (\ s a -> s{_ddsLimit = a}) . mapping _Nat;
gen/Network/AWS/Firehose/ListDeliveryStreams.hs view
@@ -20,14 +20,7 @@ -- -- 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
gen/Network/AWS/Firehose/PutRecord.hs view
@@ -18,43 +18,19 @@ -- 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>.+-- 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.+-- 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. ----- 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.+-- 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. ----- 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.+-- 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.+-- 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.+-- 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
gen/Network/AWS/Firehose/PutRecordBatch.hs view
@@ -18,70 +18,23 @@ -- 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>.+-- 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.+-- 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. ----- 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.+-- 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. ----- 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.+-- 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.+-- 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 __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.+-- 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@@ -215,8 +168,7 @@ prbrsFailedPutCount :: Lens' PutRecordBatchResponse Natural prbrsFailedPutCount = lens _prbrsFailedPutCount (\ s a -> s{_prbrsFailedPutCount = a}) . _Nat; --- | The results for the individual records. The index of each element--- matches the same index in which records were sent.+-- | The results for the individual records. The index of each element matches the same index in which records were sent. prbrsRequestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry) prbrsRequestResponses = lens _prbrsRequestResponses (\ s a -> s{_prbrsRequestResponses = a}) . _List1;
gen/Network/AWS/Firehose/Types.hs view
@@ -263,17 +263,12 @@ _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.+-- | 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"
gen/Network/AWS/Firehose/Types/Product.hs view
@@ -21,10 +21,7 @@ import           Network.AWS.Lens import           Network.AWS.Prelude --- | 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.+-- | 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'@@ -47,18 +44,13 @@     , _bhIntervalInSeconds = Nothing     } --- | Buffer incoming data to the specified size, in MBs, before delivering it--- to the destination. The default value is 5.+-- | 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.+-- 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; --- | Buffer incoming data for the specified period of time, in seconds,--- before delivering it to the destination. The default value is 300.+-- | Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. bhIntervalInSeconds :: Lens' BufferingHints (Maybe Natural) bhIntervalInSeconds = lens _bhIntervalInSeconds (\ s a -> s{_bhIntervalInSeconds = a}) . mapping _Nat; @@ -111,13 +103,11 @@ cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool) cwloEnabled = lens _cwloEnabled (\ s a -> s{_cwloEnabled = a}); --- | The CloudWatch group name for logging. This value is required if Enabled--- is true.+-- | The CloudWatch group name for logging. This value is required if Enabled is true. cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) cwloLogGroupName = lens _cwloLogGroupName (\ s a -> s{_cwloLogGroupName = a}); --- | The CloudWatch log stream name for logging. This value is required if--- Enabled is true.+-- | The CloudWatch log stream name for logging. This value is required if Enabled is true. cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) cwloLogStreamName = lens _cwloLogStreamName (\ s a -> s{_cwloLogStreamName = a}); @@ -169,28 +159,19 @@     , _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.+-- | 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 \'\\t\' lzop;' - fields are delimited with \"\\t\" (TAB character) and compressed using lzop. ----- 'delimiter \'|' - fields are delimited with \"|\" (this is the default--- delimiter).+-- '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.+-- '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.+-- '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>.+-- 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}); @@ -198,8 +179,7 @@ ccDataTableColumns :: Lens' CopyCommand (Maybe Text) ccDataTableColumns = lens _ccDataTableColumns (\ s a -> s{_ccDataTableColumns = a}); --- | The name of the target table. The table must already exist in the--- database.+-- | The name of the target table. The table must already exist in the database. ccDataTableName :: Lens' CopyCommand Text ccDataTableName = lens _ccDataTableName (\ s a -> s{_ccDataTableName = a}); @@ -295,11 +275,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}); @@ -391,8 +367,7 @@  instance NFData DestinationDescription --- | Describes the buffering to perform before delivering data to the Amazon--- ES destination.+-- | Describes the buffering to perform before delivering data to the Amazon ES destination. -- -- /See:/ 'elasticsearchBufferingHints' smart constructor. data ElasticsearchBufferingHints = ElasticsearchBufferingHints'@@ -415,19 +390,13 @@     , _ebhIntervalInSeconds = Nothing     } --- | Buffer incoming data to the specified size, in MBs, before delivering it--- to the destination. The default value is 5.+-- | 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.+-- 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; --- | Buffer incoming data for the specified period of time, in seconds,--- before delivering it to the destination. The default value is 300 (5--- minutes).+-- | Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). ebhIntervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural) ebhIntervalInSeconds = lens _ebhIntervalInSeconds (\ s a -> s{_ebhIntervalInSeconds = a}) . mapping _Nat; @@ -509,23 +478,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}); @@ -533,26 +490,19 @@ edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) edcCloudWatchLoggingOptions = lens _edcCloudWatchLoggingOptions (\ s a -> s{_edcCloudWatchLoggingOptions = a}); --- | Buffering options. If no value is specified,--- __ElasticsearchBufferingHints__ object default values are used.+-- | Buffering options. If no value is specified, __ElasticsearchBufferingHints__ object default values are used. edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) edcBufferingHints = lens _edcBufferingHints (\ s a -> s{_edcBufferingHints = a}); --- | Configures retry behavior in the event that Firehose is unable to--- deliver documents to Amazon ES. Default value is 300 (5 minutes).+-- | Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). 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}); @@ -757,11 +707,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}); @@ -769,9 +715,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}); @@ -783,20 +727,15 @@ eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) eduS3Update = lens _eduS3Update (\ s a -> s{_eduS3Update = a}); --- | Buffering options. If no value is specified,--- __ElasticsearchBufferingHints__ object default values are used.+-- | Buffering options. If no value is specified, __ElasticsearchBufferingHints__ object default values are used. eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) eduBufferingHints = lens _eduBufferingHints (\ s a -> s{_eduBufferingHints = a}); --- | Configures retry behavior in the event that Firehose is unable to--- deliver documents to Amazon ES. Default value is 300 (5 minutes).+-- | Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). 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}); @@ -824,8 +763,7 @@                   ("RoleARN" .=) <$> _eduRoleARN,                   ("IndexName" .=) <$> _eduIndexName]) --- | Configures retry behavior in the event that Firehose is unable to--- deliver documents to Amazon ES.+-- | Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. -- -- /See:/ 'elasticsearchRetryOptions' smart constructor. newtype ElasticsearchRetryOptions = ElasticsearchRetryOptions'@@ -844,10 +782,7 @@     { _eroDurationInSeconds = Nothing     } --- | After an initial failure to deliver to Amazon ES, the total amount of--- time during which Firehose re-attempts delivery. After this time has--- elapsed, the failed documents are written to Amazon S3. Default value is--- 300 seconds. A value of 0 (zero) results in no retries.+-- | After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery. After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds. A value of 0 (zero) results in no retries. eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural) eroDurationInSeconds = lens _eroDurationInSeconds (\ s a -> s{_eroDurationInSeconds = a}) . mapping _Nat; @@ -891,8 +826,7 @@     , _ecKMSEncryptionConfig = Nothing     } --- | Specifically override existing encryption information to ensure no--- encryption is used.+-- | Specifically override existing encryption information to ensure no encryption is used. ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) ecNoEncryptionConfig = lens _ecNoEncryptionConfig (\ s a -> s{_ecNoEncryptionConfig = a}); @@ -940,8 +874,7 @@     { _kecAWSKMSKeyARN = pAWSKMSKeyARN_     } --- | The ARN of the encryption key. Must belong to the same region as the--- destination Amazon S3 bucket.+-- | The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket. kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text kecAWSKMSKeyARN = lens _kecAWSKMSKeyARN (\ s a -> s{_kecAWSKMSKeyARN = a}); @@ -961,10 +894,7 @@               (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'@@ -1035,8 +965,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.+-- | 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.@@ -1127,14 +1056,9 @@ 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 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 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}); @@ -1294,10 +1218,7 @@  -- | 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 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}); @@ -1379,12 +1300,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/ guide-fh-dev>.+-- | 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/ guide-fh-dev>. sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text) sdcPrefix = lens _sdcPrefix (\ s a -> s{_sdcPrefix = a}); @@ -1392,22 +1308,17 @@ sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) sdcCloudWatchLoggingOptions = lens _sdcCloudWatchLoggingOptions (\ s a -> s{_sdcCloudWatchLoggingOptions = a}); --- | The encryption configuration. If no value is specified, the default is--- no encryption.+-- | The encryption configuration. If no value is specified, the default is no encryption. 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 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 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}); --- | The buffering option. If no value is specified, __BufferingHints__--- object default values are used.+-- | The buffering option. If no value is specified, __BufferingHints__ object default values are used. sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) sdcBufferingHints = lens _sdcBufferingHints (\ s a -> s{_sdcBufferingHints = a}); @@ -1485,12 +1396,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/ guide-fh-dev>.+-- | 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/ guide-fh-dev>. sddPrefix :: Lens' S3DestinationDescription (Maybe Text) sddPrefix = lens _sddPrefix (\ s a -> s{_sddPrefix = a}); @@ -1506,18 +1412,15 @@ sddBucketARN :: Lens' S3DestinationDescription Text sddBucketARN = lens _sddBucketARN (\ s a -> s{_sddBucketARN = a}); --- | The buffering option. If no value is specified, __BufferingHints__--- object default values are used.+-- | The buffering option. If no value is specified, __BufferingHints__ object default values are used. 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}); --- | The encryption configuration. If no value is specified, the default is--- no encryption.+-- | The encryption configuration. If no value is specified, the default is no encryption. sddEncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration sddEncryptionConfiguration = lens _sddEncryptionConfiguration (\ s a -> s{_sddEncryptionConfiguration = a}); @@ -1581,12 +1484,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/ guide-fh-dev>.+-- | 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/ guide-fh-dev>. sduPrefix :: Lens' S3DestinationUpdate (Maybe Text) sduPrefix = lens _sduPrefix (\ s a -> s{_sduPrefix = a}); @@ -1594,22 +1492,17 @@ sduCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) sduCloudWatchLoggingOptions = lens _sduCloudWatchLoggingOptions (\ s a -> s{_sduCloudWatchLoggingOptions = a}); --- | The encryption configuration. If no value is specified, the default is--- no encryption.+-- | The encryption configuration. If no value is specified, the default is no encryption. 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 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 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}); --- | The buffering option. If no value is specified, __BufferingHints__--- object default values are used.+-- | The buffering option. If no value is specified, __BufferingHints__ object default values are used. sduBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) sduBufferingHints = lens _sduBufferingHints (\ s a -> s{_sduBufferingHints = a});
gen/Network/AWS/Firehose/UpdateDestination.hs view
@@ -18,41 +18,15 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- 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.+-- 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.+-- 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.+-- 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@@ -138,13 +112,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});
test/Test/AWS/Gen/Firehose.hs view
@@ -28,49 +28,49 @@ -- fixtures :: TestTree -- fixtures = --     [ testGroup "request"---         [ testPutRecord $+--         [ requestPutRecord $ --             putRecord -----         , testUpdateDestination $+--         , requestUpdateDestination $ --             updateDestination -----         , testPutRecordBatch $+--         , requestPutRecordBatch $ --             putRecordBatch -----         , testCreateDeliveryStream $+--         , requestCreateDeliveryStream $ --             createDeliveryStream -----         , testDescribeDeliveryStream $+--         , requestDescribeDeliveryStream $ --             describeDeliveryStream -----         , testListDeliveryStreams $+--         , requestListDeliveryStreams $ --             listDeliveryStreams -----         , testDeleteDeliveryStream $+--         , requestDeleteDeliveryStream $ --             deleteDeliveryStream -- --           ]  --     , testGroup "response"---         [ testPutRecordResponse $+--         [ responsePutRecord $ --             putRecordResponse -----         , testUpdateDestinationResponse $+--         , responseUpdateDestination $ --             updateDestinationResponse -----         , testPutRecordBatchResponse $+--         , responsePutRecordBatch $ --             putRecordBatchResponse -----         , testCreateDeliveryStreamResponse $+--         , responseCreateDeliveryStream $ --             createDeliveryStreamResponse -----         , testDescribeDeliveryStreamResponse $+--         , responseDescribeDeliveryStream $ --             describeDeliveryStreamResponse -----         , testListDeliveryStreamsResponse $+--         , responseListDeliveryStreams $ --             listDeliveryStreamsResponse -----         , testDeleteDeliveryStreamResponse $+--         , responseDeleteDeliveryStream $ --             deleteDeliveryStreamResponse -- --           ]@@ -78,87 +78,87 @@  -- Requests -testPutRecord :: PutRecord -> TestTree-testPutRecord = req+requestPutRecord :: PutRecord -> TestTree+requestPutRecord = req     "PutRecord"     "fixture/PutRecord.yaml" -testUpdateDestination :: UpdateDestination -> TestTree-testUpdateDestination = req+requestUpdateDestination :: UpdateDestination -> TestTree+requestUpdateDestination = req     "UpdateDestination"     "fixture/UpdateDestination.yaml" -testPutRecordBatch :: PutRecordBatch -> TestTree-testPutRecordBatch = req+requestPutRecordBatch :: PutRecordBatch -> TestTree+requestPutRecordBatch = req     "PutRecordBatch"     "fixture/PutRecordBatch.yaml" -testCreateDeliveryStream :: CreateDeliveryStream -> TestTree-testCreateDeliveryStream = req+requestCreateDeliveryStream :: CreateDeliveryStream -> TestTree+requestCreateDeliveryStream = req     "CreateDeliveryStream"     "fixture/CreateDeliveryStream.yaml" -testDescribeDeliveryStream :: DescribeDeliveryStream -> TestTree-testDescribeDeliveryStream = req+requestDescribeDeliveryStream :: DescribeDeliveryStream -> TestTree+requestDescribeDeliveryStream = req     "DescribeDeliveryStream"     "fixture/DescribeDeliveryStream.yaml" -testListDeliveryStreams :: ListDeliveryStreams -> TestTree-testListDeliveryStreams = req+requestListDeliveryStreams :: ListDeliveryStreams -> TestTree+requestListDeliveryStreams = req     "ListDeliveryStreams"     "fixture/ListDeliveryStreams.yaml" -testDeleteDeliveryStream :: DeleteDeliveryStream -> TestTree-testDeleteDeliveryStream = req+requestDeleteDeliveryStream :: DeleteDeliveryStream -> TestTree+requestDeleteDeliveryStream = req     "DeleteDeliveryStream"     "fixture/DeleteDeliveryStream.yaml"  -- Responses -testPutRecordResponse :: PutRecordResponse -> TestTree-testPutRecordResponse = res+responsePutRecord :: PutRecordResponse -> TestTree+responsePutRecord = res     "PutRecordResponse"     "fixture/PutRecordResponse.proto"     firehose     (Proxy :: Proxy PutRecord) -testUpdateDestinationResponse :: UpdateDestinationResponse -> TestTree-testUpdateDestinationResponse = res+responseUpdateDestination :: UpdateDestinationResponse -> TestTree+responseUpdateDestination = res     "UpdateDestinationResponse"     "fixture/UpdateDestinationResponse.proto"     firehose     (Proxy :: Proxy UpdateDestination) -testPutRecordBatchResponse :: PutRecordBatchResponse -> TestTree-testPutRecordBatchResponse = res+responsePutRecordBatch :: PutRecordBatchResponse -> TestTree+responsePutRecordBatch = res     "PutRecordBatchResponse"     "fixture/PutRecordBatchResponse.proto"     firehose     (Proxy :: Proxy PutRecordBatch) -testCreateDeliveryStreamResponse :: CreateDeliveryStreamResponse -> TestTree-testCreateDeliveryStreamResponse = res+responseCreateDeliveryStream :: CreateDeliveryStreamResponse -> TestTree+responseCreateDeliveryStream = res     "CreateDeliveryStreamResponse"     "fixture/CreateDeliveryStreamResponse.proto"     firehose     (Proxy :: Proxy CreateDeliveryStream) -testDescribeDeliveryStreamResponse :: DescribeDeliveryStreamResponse -> TestTree-testDescribeDeliveryStreamResponse = res+responseDescribeDeliveryStream :: DescribeDeliveryStreamResponse -> TestTree+responseDescribeDeliveryStream = res     "DescribeDeliveryStreamResponse"     "fixture/DescribeDeliveryStreamResponse.proto"     firehose     (Proxy :: Proxy DescribeDeliveryStream) -testListDeliveryStreamsResponse :: ListDeliveryStreamsResponse -> TestTree-testListDeliveryStreamsResponse = res+responseListDeliveryStreams :: ListDeliveryStreamsResponse -> TestTree+responseListDeliveryStreams = res     "ListDeliveryStreamsResponse"     "fixture/ListDeliveryStreamsResponse.proto"     firehose     (Proxy :: Proxy ListDeliveryStreams) -testDeleteDeliveryStreamResponse :: DeleteDeliveryStreamResponse -> TestTree-testDeleteDeliveryStreamResponse = res+responseDeleteDeliveryStream :: DeleteDeliveryStreamResponse -> TestTree+responseDeleteDeliveryStream = res     "DeleteDeliveryStreamResponse"     "fixture/DeleteDeliveryStreamResponse.proto"     firehose