Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.Firehose
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- CompressionFormat
- DeliveryStreamStatus
- DeliveryStreamType
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- HECEndpointType
- NoEncryptionConfig
- OrcCompression
- OrcFormatVersion
- ParquetCompression
- ParquetWriterVersion
- ProcessorParameterName
- ProcessorType
- RedshiftS3BackupMode
- S3BackupMode
- SplunkS3BackupMode
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DataFormatConversionConfiguration
- DeliveryStreamDescription
- Deserializer
- DestinationDescription
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- ExtendedS3DestinationConfiguration
- ExtendedS3DestinationDescription
- ExtendedS3DestinationUpdate
- HiveJSONSerDe
- InputFormatConfiguration
- KMSEncryptionConfig
- KinesisStreamSourceConfiguration
- KinesisStreamSourceDescription
- OpenXJSONSerDe
- OrcSerDe
- OutputFormatConfiguration
- ParquetSerDe
- ProcessingConfiguration
- Processor
- ProcessorParameter
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- SchemaConfiguration
- Serializer
- SourceDescription
- SplunkDestinationConfiguration
- SplunkDestinationDescription
- SplunkDestinationUpdate
- SplunkRetryOptions
- Tag
Description
Amazon Kinesis Data Firehose API Reference
Amazon Kinesis Data 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), Amazon Redshift, and Splunk.
Synopsis
- 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
- module Network.AWS.Firehose.PutRecord
- module Network.AWS.Firehose.TagDeliveryStream
- module Network.AWS.Firehose.UpdateDestination
- module Network.AWS.Firehose.PutRecordBatch
- module Network.AWS.Firehose.UntagDeliveryStream
- module Network.AWS.Firehose.CreateDeliveryStream
- module Network.AWS.Firehose.DescribeDeliveryStream
- module Network.AWS.Firehose.ListTagsForDeliveryStream
- module Network.AWS.Firehose.ListDeliveryStreams
- module Network.AWS.Firehose.DeleteDeliveryStream
- data CompressionFormat
- = Gzip
- | Snappy
- | Uncompressed
- | Zip
- data DeliveryStreamStatus
- data DeliveryStreamType
- data ElasticsearchIndexRotationPeriod
- = NoRotation
- | OneDay
- | OneHour
- | OneMonth
- | OneWeek
- data ElasticsearchS3BackupMode
- data HECEndpointType
- data NoEncryptionConfig = NoEncryption
- data OrcCompression
- data OrcFormatVersion
- data ParquetCompression
- data ParquetWriterVersion
- data ProcessorParameterName
- data ProcessorType = Lambda
- data RedshiftS3BackupMode
- data S3BackupMode
- data SplunkS3BackupMode
- 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 DataFormatConversionConfiguration
- dataFormatConversionConfiguration :: DataFormatConversionConfiguration
- dfccOutputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration)
- dfccEnabled :: Lens' DataFormatConversionConfiguration (Maybe Bool)
- dfccSchemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration)
- dfccInputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration)
- data DeliveryStreamDescription
- deliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> DeliveryStreamType -> Text -> Bool -> DeliveryStreamDescription
- dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription)
- dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus
- dsdDeliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType
- dsdVersionId :: Lens' DeliveryStreamDescription Text
- dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription]
- dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool
- data Deserializer
- deserializer :: Deserializer
- dOpenXJSONSerDe :: Lens' Deserializer (Maybe OpenXJSONSerDe)
- dHiveJSONSerDe :: Lens' Deserializer (Maybe HiveJSONSerDe)
- data DestinationDescription
- destinationDescription :: Text -> DestinationDescription
- ddSplunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription)
- ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- ddExtendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription)
- 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)
- edcProcessingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration)
- 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)
- eddProcessingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration)
- 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)
- eduProcessingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration)
- 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 ExtendedS3DestinationConfiguration
- extendedS3DestinationConfiguration :: Text -> Text -> ExtendedS3DestinationConfiguration
- esdcS3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode)
- esdcPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- esdcCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- esdcS3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration)
- esdcEncryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration)
- esdcCompressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat)
- esdcBufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints)
- esdcDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration)
- esdcProcessingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration)
- esdcRoleARN :: Lens' ExtendedS3DestinationConfiguration Text
- esdcBucketARN :: Lens' ExtendedS3DestinationConfiguration Text
- data ExtendedS3DestinationDescription
- extendedS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> ExtendedS3DestinationDescription
- esddS3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode)
- esddS3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription)
- esddPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- esddCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions)
- esddDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration)
- esddProcessingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration)
- esddRoleARN :: Lens' ExtendedS3DestinationDescription Text
- esddBucketARN :: Lens' ExtendedS3DestinationDescription Text
- esddBufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints
- esddCompressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat
- esddEncryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration
- data ExtendedS3DestinationUpdate
- extendedS3DestinationUpdate :: ExtendedS3DestinationUpdate
- esduS3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode)
- esduPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- esduS3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate)
- esduEncryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration)
- esduCompressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat)
- esduBufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints)
- esduDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration)
- esduBucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduProcessingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration)
- esduRoleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- data HiveJSONSerDe
- hiveJSONSerDe :: HiveJSONSerDe
- hjsdTimestampFormats :: Lens' HiveJSONSerDe [Text]
- data InputFormatConfiguration
- inputFormatConfiguration :: InputFormatConfiguration
- ifcDeserializer :: Lens' InputFormatConfiguration (Maybe Deserializer)
- data KMSEncryptionConfig
- kmsEncryptionConfig :: Text -> KMSEncryptionConfig
- kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- data KinesisStreamSourceConfiguration
- kinesisStreamSourceConfiguration :: Text -> Text -> KinesisStreamSourceConfiguration
- ksscKinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text
- ksscRoleARN :: Lens' KinesisStreamSourceConfiguration Text
- data KinesisStreamSourceDescription
- kinesisStreamSourceDescription :: KinesisStreamSourceDescription
- kssdDeliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime)
- kssdKinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- kssdRoleARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- data OpenXJSONSerDe
- openXJSONSerDe :: OpenXJSONSerDe
- oxjsdColumnToJSONKeyMappings :: Lens' OpenXJSONSerDe (HashMap Text Text)
- oxjsdCaseInsensitive :: Lens' OpenXJSONSerDe (Maybe Bool)
- oxjsdConvertDotsInJSONKeysToUnderscores :: Lens' OpenXJSONSerDe (Maybe Bool)
- data OrcSerDe
- orcSerDe :: OrcSerDe
- osdBloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double)
- osdDictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double)
- osdEnablePadding :: Lens' OrcSerDe (Maybe Bool)
- osdCompression :: Lens' OrcSerDe (Maybe OrcCompression)
- osdBloomFilterColumns :: Lens' OrcSerDe [Text]
- osdRowIndexStride :: Lens' OrcSerDe (Maybe Natural)
- osdFormatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion)
- osdBlockSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- osdStripeSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- osdPaddingTolerance :: Lens' OrcSerDe (Maybe Double)
- data OutputFormatConfiguration
- outputFormatConfiguration :: OutputFormatConfiguration
- ofcSerializer :: Lens' OutputFormatConfiguration (Maybe Serializer)
- data ParquetSerDe
- parquetSerDe :: ParquetSerDe
- psdWriterVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion)
- psdCompression :: Lens' ParquetSerDe (Maybe ParquetCompression)
- psdMaxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural)
- psdEnableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool)
- psdPageSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- psdBlockSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- data ProcessingConfiguration
- processingConfiguration :: ProcessingConfiguration
- pcEnabled :: Lens' ProcessingConfiguration (Maybe Bool)
- pcProcessors :: Lens' ProcessingConfiguration [Processor]
- data Processor
- processor :: ProcessorType -> Processor
- pParameters :: Lens' Processor [ProcessorParameter]
- pType :: Lens' Processor ProcessorType
- data ProcessorParameter
- processorParameter :: ProcessorParameterName -> Text -> ProcessorParameter
- ppParameterName :: Lens' ProcessorParameter ProcessorParameterName
- ppParameterValue :: Lens' ProcessorParameter 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
- rdcS3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)
- rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- rdcS3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)
- rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- rdcProcessingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)
- 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
- rddS3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode)
- rddS3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription)
- rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- rddProcessingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration)
- rddRoleARN :: Lens' RedshiftDestinationDescription Text
- rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text
- rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand
- rddUsername :: Lens' RedshiftDestinationDescription Text
- rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription
- data RedshiftDestinationUpdate
- redshiftDestinationUpdate :: RedshiftDestinationUpdate
- rduS3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode)
- rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- rduProcessingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration)
- 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
- s3Prefix :: Lens' S3DestinationDescription (Maybe Text)
- s3CloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- s3RoleARN :: Lens' S3DestinationDescription Text
- s3BucketARN :: Lens' S3DestinationDescription Text
- s3BufferingHints :: Lens' S3DestinationDescription BufferingHints
- s3CompressionFormat :: Lens' S3DestinationDescription CompressionFormat
- s3EncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration
- data S3DestinationUpdate
- s3DestinationUpdate :: S3DestinationUpdate
- sPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- sCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- sEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- sCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- sBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- sBucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- sRoleARN :: Lens' S3DestinationUpdate (Maybe Text)
- data SchemaConfiguration
- schemaConfiguration :: SchemaConfiguration
- scVersionId :: Lens' SchemaConfiguration (Maybe Text)
- scCatalogId :: Lens' SchemaConfiguration (Maybe Text)
- scDatabaseName :: Lens' SchemaConfiguration (Maybe Text)
- scRegion :: Lens' SchemaConfiguration (Maybe Text)
- scTableName :: Lens' SchemaConfiguration (Maybe Text)
- scRoleARN :: Lens' SchemaConfiguration (Maybe Text)
- data Serializer
- serializer :: Serializer
- sOrcSerDe :: Lens' Serializer (Maybe OrcSerDe)
- sParquetSerDe :: Lens' Serializer (Maybe ParquetSerDe)
- data SourceDescription
- sourceDescription :: SourceDescription
- sdKinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription)
- data SplunkDestinationConfiguration
- splunkDestinationConfiguration :: Text -> HECEndpointType -> Text -> S3DestinationConfiguration -> SplunkDestinationConfiguration
- splS3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode)
- splCloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- splHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural)
- splRetryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions)
- splProcessingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration)
- splHECEndpoint :: Lens' SplunkDestinationConfiguration Text
- splHECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType
- splHECToken :: Lens' SplunkDestinationConfiguration Text
- splS3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration
- data SplunkDestinationDescription
- splunkDestinationDescription :: SplunkDestinationDescription
- sddS3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode)
- sddHECToken :: Lens' SplunkDestinationDescription (Maybe Text)
- sddHECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType)
- sddCloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions)
- sddHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural)
- sddS3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription)
- sddHECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text)
- sddRetryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions)
- sddProcessingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration)
- data SplunkDestinationUpdate
- splunkDestinationUpdate :: SplunkDestinationUpdate
- sduS3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode)
- sduHECToken :: Lens' SplunkDestinationUpdate (Maybe Text)
- sduHECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType)
- sduCloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions)
- sduHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural)
- sduS3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate)
- sduHECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text)
- sduRetryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions)
- sduProcessingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration)
- data SplunkRetryOptions
- splunkRetryOptions :: SplunkRetryOptions
- sroDurationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural)
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag Text
Service Configuration
API version 2015-08-04
of the Amazon Kinesis Firehose SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Firehose
.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified input parameter has a value that is not valid.
ConcurrentModificationException
_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
_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 Data Firehose Limits .
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached the limit for a requested resource.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already in use and not available for this operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
PutRecord
TagDeliveryStream
UpdateDestination
PutRecordBatch
UntagDeliveryStream
CreateDeliveryStream
DescribeDeliveryStream
ListTagsForDeliveryStream
ListDeliveryStreams
DeleteDeliveryStream
Types
CompressionFormat
data CompressionFormat Source #
Constructors
Gzip | |
Snappy | |
Uncompressed | |
Zip |
Instances
DeliveryStreamStatus
data DeliveryStreamStatus Source #
Instances
DeliveryStreamType
data DeliveryStreamType Source #
Constructors
DirectPut | |
KinesisStreamAsSource |
Instances
ElasticsearchIndexRotationPeriod
data ElasticsearchIndexRotationPeriod Source #
Constructors
NoRotation | |
OneDay | |
OneHour | |
OneMonth | |
OneWeek |
Instances
ElasticsearchS3BackupMode
data ElasticsearchS3BackupMode Source #
Constructors
AllDocuments | |
FailedDocumentsOnly |
Instances
HECEndpointType
data HECEndpointType Source #
Instances
NoEncryptionConfig
data NoEncryptionConfig Source #
Constructors
NoEncryption |
Instances
OrcCompression
data OrcCompression Source #
Instances
OrcFormatVersion
data OrcFormatVersion Source #
Instances
ParquetCompression
data ParquetCompression Source #
Constructors
PCGzip | |
PCSnappy | |
PCUncompressed |
Instances
ParquetWriterVersion
data ParquetWriterVersion Source #
Instances
ProcessorParameterName
data ProcessorParameterName Source #
Instances
ProcessorType
data ProcessorType Source #
Constructors
Lambda |
Instances
RedshiftS3BackupMode
data RedshiftS3BackupMode Source #
Instances
S3BackupMode
data S3BackupMode Source #
Constructors
SBMDisabled | |
SBMEnabled |
Instances
SplunkS3BackupMode
data SplunkS3BackupMode Source #
Constructors
AllEvents | |
FailedEventsOnly |
Instances
BufferingHints
data BufferingHints Source #
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal.
See: bufferingHints
smart constructor.
Instances
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
- Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter 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, the value should be 10 MB or higher.bhIntervalInSeconds
- Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
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 this parameter 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, the value should 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 the Amazon CloudWatch logging options for your delivery stream.
See: cloudWatchLoggingOptions
smart constructor.
Instances
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
- Enables or disables CloudWatch logging.cwloLogGroupName
- The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.cwloLogStreamName
- The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
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 CloudWatch logging is enabled.
cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CopyCommand
data CopyCommand Source #
Describes a COPY
command for Amazon Redshift.
See: copyCommand
smart constructor.
Instances
Arguments
:: Text | |
-> CopyCommand |
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
- Optional parameters to use with the Amazon RedshiftCOPY
command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Data 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
- A comma-separated list of column names.ccDataTableName
- The name of the target table. The table must already exist in the database.
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 Kinesis Data 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.
DataFormatConversionConfiguration
data DataFormatConversionConfiguration Source #
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion .
See: dataFormatConversionConfiguration
smart constructor.
Instances
dataFormatConversionConfiguration :: DataFormatConversionConfiguration Source #
Creates a value of DataFormatConversionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfccOutputFormatConfiguration
- Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.dfccEnabled
- Defaults totrue
. Set it tofalse
if you want to disable format conversion while preserving the configuration details.dfccSchemaConfiguration
- Specifies the AWS Glue Data Catalog table that contains the column information.dfccInputFormatConfiguration
- Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.
dfccOutputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration) Source #
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.
dfccEnabled :: Lens' DataFormatConversionConfiguration (Maybe Bool) Source #
Defaults to true
. Set it to false
if you want to disable format conversion while preserving the configuration details.
dfccSchemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration) Source #
Specifies the AWS Glue Data Catalog table that contains the column information.
dfccInputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration) Source #
Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: deliveryStreamDescription
smart constructor.
Instances
deliveryStreamDescription Source #
Arguments
:: Text | |
-> Text | |
-> DeliveryStreamStatus | |
-> DeliveryStreamType | |
-> 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
- The date and time that the delivery stream was created.dsdSource
- If theDeliveryStreamType
parameter isKinesisStreamAsSource
, aSourceDescription
object describing the source Kinesis data stream.dsdLastUpdateTimestamp
- The date and time that the delivery stream was last updated.dsdDeliveryStreamName
- The name of the delivery stream.dsdDeliveryStreamARN
- The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .dsdDeliveryStreamStatus
- The status of the delivery stream.dsdDeliveryStreamType
- The delivery stream type. This can be one of the following values: *DirectPut
: Provider applications access the delivery stream directly. *KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.dsdVersionId
- Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID 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
- The destinations.dsdHasMoreDestinations
- Indicates whether there are more destinations available to list.
dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #
If the DeliveryStreamType
parameter is KinesisStreamAsSource
, a SourceDescription
object describing the source Kinesis data stream.
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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #
The status of the delivery stream.
dsdDeliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType Source #
The delivery stream type. This can be one of the following values: * DirectPut
: Provider applications access the delivery stream directly. * KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
dsdVersionId :: Lens' DeliveryStreamDescription Text Source #
Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID 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.
Deserializer
data Deserializer Source #
The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer
. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe .
See: deserializer
smart constructor.