Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- CompressionFormat
- DeliveryStreamStatus
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- NoEncryptionConfig
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DeliveryStreamDescription
- DestinationDescription
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- KMSEncryptionConfig
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- firehose :: Service
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data CompressionFormat
- = Gzip
- | Snappy
- | Uncompressed
- | Zip
- data DeliveryStreamStatus
- data ElasticsearchIndexRotationPeriod
- = NoRotation
- | OneDay
- | OneHour
- | OneMonth
- | OneWeek
- data ElasticsearchS3BackupMode
- data NoEncryptionConfig = NoEncryption
- data BufferingHints
- bufferingHints :: BufferingHints
- bhSizeInMBs :: Lens' BufferingHints (Maybe Natural)
- bhIntervalInSeconds :: Lens' BufferingHints (Maybe Natural)
- data CloudWatchLoggingOptions
- cloudWatchLoggingOptions :: CloudWatchLoggingOptions
- cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool)
- cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- data CopyCommand
- copyCommand :: Text -> CopyCommand
- ccCopyOptions :: Lens' CopyCommand (Maybe Text)
- ccDataTableColumns :: Lens' CopyCommand (Maybe Text)
- ccDataTableName :: Lens' CopyCommand Text
- data DeliveryStreamDescription
- deliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> Text -> Bool -> DeliveryStreamDescription
- dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus
- dsdVersionId :: Lens' DeliveryStreamDescription Text
- dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription]
- dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool
- data DestinationDescription
- destinationDescription :: Text -> DestinationDescription
- ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription)
- ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription)
- ddDestinationId :: Lens' DestinationDescription Text
- data ElasticsearchBufferingHints
- elasticsearchBufferingHints :: ElasticsearchBufferingHints
- ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- ebhIntervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- data ElasticsearchDestinationConfiguration
- elasticsearchDestinationConfiguration :: Text -> Text -> Text -> Text -> S3DestinationConfiguration -> ElasticsearchDestinationConfiguration
- edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod)
- edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode)
- edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints)
- edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions)
- edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text
- edcTypeName :: Lens' ElasticsearchDestinationConfiguration Text
- edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration
- data ElasticsearchDestinationDescription
- elasticsearchDestinationDescription :: ElasticsearchDestinationDescription
- eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod)
- eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode)
- eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions)
- eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription)
- eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints)
- eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions)
- eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- data ElasticsearchDestinationUpdate
- elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate
- eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod)
- eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions)
- eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate)
- eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints)
- eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions)
- eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- data ElasticsearchRetryOptions
- elasticsearchRetryOptions :: ElasticsearchRetryOptions
- eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural)
- data EncryptionConfiguration
- encryptionConfiguration :: EncryptionConfiguration
- ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig)
- ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig)
- data KMSEncryptionConfig
- kmsEncryptionConfig :: Text -> KMSEncryptionConfig
- kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- data PutRecordBatchResponseEntry
- putRecordBatchResponseEntry :: PutRecordBatchResponseEntry
- prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- data Record
- record :: ByteString -> Record
- rData :: Lens' Record ByteString
- data RedshiftDestinationConfiguration
- redshiftDestinationConfiguration :: Text -> Text -> CopyCommand -> Text -> Text -> S3DestinationConfiguration -> RedshiftDestinationConfiguration
- rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text
- rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text
- rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand
- rdcUsername :: Lens' RedshiftDestinationConfiguration Text
- rdcPassword :: Lens' RedshiftDestinationConfiguration Text
- rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration
- data RedshiftDestinationDescription
- redshiftDestinationDescription :: Text -> Text -> CopyCommand -> Text -> S3DestinationDescription -> RedshiftDestinationDescription
- rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- rddRoleARN :: Lens' RedshiftDestinationDescription Text
- rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text
- rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand
- rddUsername :: Lens' RedshiftDestinationDescription Text
- rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription
- data RedshiftDestinationUpdate
- redshiftDestinationUpdate :: RedshiftDestinationUpdate
- rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text)
- data RedshiftRetryOptions
- redshiftRetryOptions :: RedshiftRetryOptions
- rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural)
- data S3DestinationConfiguration
- s3DestinationConfiguration :: Text -> Text -> S3DestinationConfiguration
- sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text)
- sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration)
- sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat)
- sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints)
- sdcRoleARN :: Lens' S3DestinationConfiguration Text
- sdcBucketARN :: Lens' S3DestinationConfiguration Text
- data S3DestinationDescription
- s3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> S3DestinationDescription
- sddPrefix :: Lens' S3DestinationDescription (Maybe Text)
- sddCloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- sddRoleARN :: Lens' S3DestinationDescription Text
- sddBucketARN :: Lens' S3DestinationDescription Text
- sddBufferingHints :: Lens' S3DestinationDescription BufferingHints
- sddCompressionFormat :: Lens' S3DestinationDescription CompressionFormat
- sddEncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration
- data S3DestinationUpdate
- s3DestinationUpdate :: S3DestinationUpdate
- sduPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- sduCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- sduEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- sduCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- sduBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- sduBucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- sduRoleARN :: Lens' S3DestinationUpdate (Maybe Text)
Service Configuration
API version '2015-08-04' of the Amazon Kinesis Firehose SDK configuration.
Errors
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified input parameter has an value that is not valid.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification has already happened. Fetch VersionId again and use it to update the destination.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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 Amazon Kinesis Firehose Limits.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached the limit for a requested resource.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already in use and not available for this operation.
CompressionFormat
data CompressionFormat Source #
DeliveryStreamStatus
data DeliveryStreamStatus Source #
ElasticsearchIndexRotationPeriod
data ElasticsearchIndexRotationPeriod Source #
ElasticsearchS3BackupMode
data ElasticsearchS3BackupMode Source #
NoEncryptionConfig
data NoEncryptionConfig Source #
BufferingHints
data BufferingHints Source #
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.
bufferingHints :: BufferingHints Source #
Creates a value of BufferingHints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bhSizeInMBs :: Lens' BufferingHints (Maybe Natural) Source #
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 :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
CloudWatchLoggingOptions
data CloudWatchLoggingOptions Source #
Describes CloudWatch logging options for your delivery stream.
See: cloudWatchLoggingOptions
smart constructor.
cloudWatchLoggingOptions :: CloudWatchLoggingOptions Source #
Creates a value of CloudWatchLoggingOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool) Source #
Enables or disables CloudWatch logging.
cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch group name for logging. This value is required if Enabled is true.
cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch log stream name for logging. This value is required if Enabled is true.
CopyCommand
data CopyCommand Source #
Describes a COPY
command for Amazon Redshift.
See: copyCommand
smart constructor.
Creates a value of CopyCommand
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccCopyOptions :: Lens' CopyCommand (Maybe Text) Source #
Optional parameters to use with the Amazon Redshift COPY
command. For more information, see the "Optional Parameters" section of 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 Amazon Redshift COPY command examples.
ccDataTableColumns :: Lens' CopyCommand (Maybe Text) Source #
A comma-separated list of column names.
ccDataTableName :: Lens' CopyCommand Text Source #
The name of the target table. The table must already exist in the database.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: deliveryStreamDescription
smart constructor.
deliveryStreamDescription Source #
:: Text | |
-> Text | |
-> DeliveryStreamStatus | |
-> Text | |
-> Bool | |
-> DeliveryStreamDescription |
Creates a value of DeliveryStreamDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was last updated.
dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text Source #
The name of the delivery stream.
dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text Source #
The Amazon Resource Name (ARN) of the delivery stream.
dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #
The status of the delivery stream.
dsdVersionId :: Lens' DeliveryStreamDescription Text Source #
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 :: Lens' DeliveryStreamDescription [DestinationDescription] Source #
The destinations.
dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #
Indicates whether there are more destinations available to list.
DestinationDescription
data DestinationDescription Source #
Describes the destination for a delivery stream.
See: destinationDescription
smart constructor.
destinationDescription Source #
Creates a value of DestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.
ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription) Source #
The destination in Amazon ES.
ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source #
The destination in Amazon Redshift.
ddDestinationId :: Lens' DestinationDescription Text Source #
The ID of the destination.
ElasticsearchBufferingHints
data ElasticsearchBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon ES destination.
See: elasticsearchBufferingHints
smart constructor.
elasticsearchBufferingHints :: ElasticsearchBufferingHints Source #
Creates a value of ElasticsearchBufferingHints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
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 :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
ElasticsearchDestinationConfiguration
data ElasticsearchDestinationConfiguration Source #
Describes the configuration of a destination in Amazon ES.
See: elasticsearchDestinationConfiguration
smart constructor.
elasticsearchDestinationConfiguration Source #
Creates a value of ElasticsearchDestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay
.
edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) Source #
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 Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
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 Amazon S3 Bucket Access.
edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming RoleARN.
edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch index name.
edcTypeName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch type name.
edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration Source #
Undocumented member.
ElasticsearchDestinationDescription
data ElasticsearchDestinationDescription Source #
The destination description in Amazon ES.
See: elasticsearchDestinationDescription
smart constructor.
elasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #
Creates a value of ElasticsearchDestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period
eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch type name.
eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #
Amazon S3 backup mode.
eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the Amazon ES domain.
eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
CloudWatch logging options.
eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #
Buffering options.
eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #
Elasticsearch retry options.
eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the AWS credentials.
eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchDestinationUpdate
data ElasticsearchDestinationUpdate Source #
Describes an update for a destination in Amazon ES.
See: elasticsearchDestinationUpdate
smart constructor.
elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #
Creates a value of ElasticsearchDestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay
.
eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch type name.
eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
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 Amazon S3 Bucket Access.
eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchRetryOptions
data ElasticsearchRetryOptions Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.
See: elasticsearchRetryOptions
smart constructor.
elasticsearchRetryOptions :: ElasticsearchRetryOptions Source #
Creates a value of ElasticsearchRetryOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural) Source #
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.
EncryptionConfiguration
data EncryptionConfiguration Source #
Describes the encryption for a destination in Amazon S3.
See: encryptionConfiguration
smart constructor.
encryptionConfiguration :: EncryptionConfiguration Source #
Creates a value of EncryptionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #
Specifically override existing encryption information to ensure no encryption is used.
ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig) Source #
The encryption key.
KMSEncryptionConfig
data KMSEncryptionConfig Source #
Describes an encryption key for a destination in Amazon S3.
See: kmsEncryptionConfig
smart constructor.
Creates a value of KMSEncryptionConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #
The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
PutRecordBatchResponseEntry
data PutRecordBatchResponseEntry Source #
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.
putRecordBatchResponseEntry :: PutRecordBatchResponseEntry Source #
Creates a value of PutRecordBatchResponseEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The ID of the record.
prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error code for an individual record result.
prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error message for an individual record result.
Record
The unit of data in a delivery stream.
See: record
smart constructor.
:: ByteString | |
-> Record |
rData :: Lens' Record ByteString Source #
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.
RedshiftDestinationConfiguration
data RedshiftDestinationConfiguration Source #
Describes the configuration of a destination in Amazon Redshift.
See: redshiftDestinationConfiguration
smart constructor.
redshiftDestinationConfiguration Source #
:: Text | |
-> Text | |
-> CopyCommand | |
-> Text | |
-> Text | |
-> S3DestinationConfiguration | |
-> RedshiftDestinationConfiguration |
Creates a value of RedshiftDestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions) Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text Source #
The ARN of the AWS credentials.
rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text Source #
The database connection string.
rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand Source #
The COPY
command.
rdcUsername :: Lens' RedshiftDestinationConfiguration Text Source #
The name of the user.
rdcPassword :: Lens' RedshiftDestinationConfiguration Text Source #
The user password.
rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration Source #
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.
RedshiftDestinationDescription
data RedshiftDestinationDescription Source #
Describes a destination in Amazon Redshift.
See: redshiftDestinationDescription
smart constructor.
redshiftDestinationDescription Source #
Creates a value of RedshiftDestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions) Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rddRoleARN :: Lens' RedshiftDestinationDescription Text Source #
The ARN of the AWS credentials.
rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text Source #
The database connection string.
rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand Source #
The COPY
command.
rddUsername :: Lens' RedshiftDestinationDescription Text Source #
The name of the user.
rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription Source #
The Amazon S3 destination.
RedshiftDestinationUpdate
data RedshiftDestinationUpdate Source #
Describes an update for a destination in Amazon Redshift.
See: redshiftDestinationUpdate
smart constructor.
redshiftDestinationUpdate :: RedshiftDestinationUpdate Source #
Creates a value of RedshiftDestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The name of the user.
rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
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 :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The user password.
rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #
The COPY
command.
rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The database connection string.
rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The ARN of the AWS credentials.
RedshiftRetryOptions
data RedshiftRetryOptions Source #
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift.
See: redshiftRetryOptions
smart constructor.
redshiftRetryOptions :: RedshiftRetryOptions Source #
Creates a value of RedshiftRetryOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural) Source #
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.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: s3DestinationConfiguration
smart constructor.
s3DestinationConfiguration Source #
Creates a value of S3DestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
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 Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #
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 :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sdcRoleARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the AWS credentials.
sdcBucketARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the S3 bucket.
S3DestinationDescription
data S3DestinationDescription Source #
Describes a destination in Amazon S3.
See: s3DestinationDescription
smart constructor.
s3DestinationDescription Source #
:: Text | |
-> Text | |
-> BufferingHints | |
-> CompressionFormat | |
-> EncryptionConfiguration | |
-> S3DestinationDescription |
Creates a value of S3DestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sddPrefix :: Lens' S3DestinationDescription (Maybe Text) Source #
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 Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
sddCloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
sddRoleARN :: Lens' S3DestinationDescription Text Source #
The ARN of the AWS credentials.
sddBucketARN :: Lens' S3DestinationDescription Text Source #
The ARN of the S3 bucket.
sddBufferingHints :: Lens' S3DestinationDescription BufferingHints Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sddCompressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is NOCOMPRESSION
.
sddEncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
S3DestinationUpdate
data S3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: s3DestinationUpdate
smart constructor.
s3DestinationUpdate :: S3DestinationUpdate Source #
Creates a value of S3DestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sduPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
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 Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
sduCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Describes CloudWatch logging options for your delivery stream.
sduEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sduCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat) Source #
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 :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sduBucketARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket.
sduRoleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the AWS credentials.