amazonka-kinesis-firehose-1.3.7: Amazon Kinesis Firehose SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Firehose.Types

Contents

Description

 

Synopsis

Service Configuration

firehose :: Service Source

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

Constructors

Gzip 
Snappy 
Uncompressed 
Zip 

Instances

DeliveryStreamStatus

data DeliveryStreamStatus Source

Constructors

Active 
Creating 
Deleting 

Instances

NoEncryptionConfig

data NoEncryptionConfig Source

Constructors

NoEncryption 

Instances

BufferingHints

data BufferingHints Source

Describes the buffering to perform before delivering data to the destination.

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 :: 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.

CopyCommand

data CopyCommand Source

Describes a COPY command for Amazon Redshift.

See: copyCommand smart constructor.

Instances

copyCommand Source

Arguments

:: Text

ccDataTableName

-> 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 :: 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 Amazon Kinesis 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 and Amazon Redshift COPY command exmaples.

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.

Instances

deliveryStreamDescription Source

Arguments

:: Text

dsdDeliveryStreamName

-> Text

dsdDeliveryStreamARN

-> DeliveryStreamStatus

dsdDeliveryStreamStatus

-> Text

dsdVersionId

-> Bool

dsdHasMoreDestinations

-> 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.

Instances

destinationDescription Source

Arguments

:: Text

ddDestinationId

-> DestinationDescription 

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.

ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source

The destination in Amazon Redshift.

ddDestinationId :: Lens' DestinationDescription Text Source

The ID of the destination.

EncryptionConfiguration

data EncryptionConfiguration Source

Describes the encryption for a destination in Amazon S3.

See: encryptionConfiguration smart constructor.

Instances

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.

Instances

kmsEncryptionConfig Source

Arguments

:: Text

kecAWSKMSKeyARN

-> KMSEncryptionConfig 

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.

Instances

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

data Record Source

The unit of data in a delivery stream.

See: record smart constructor.

Instances

record Source

Arguments

:: ByteString

rData

-> Record 

Creates a value of Record with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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.

Instances

redshiftDestinationConfiguration Source

Arguments

:: Text

rdcRoleARN

-> Text

rdcClusterJDBCURL

-> CopyCommand

rdcCopyCommand

-> Text

rdcUsername

-> Text

rdcPassword

-> S3DestinationConfiguration

rdcS3Configuration

-> 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:

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 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.

Instances

redshiftDestinationDescription Source

Arguments

:: Text

rddRoleARN

-> Text

rddClusterJDBCURL

-> CopyCommand

rddCopyCommand

-> Text

rddUsername

-> S3DestinationDescription

rddS3DestinationDescription

-> RedshiftDestinationDescription 

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:

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.

Instances

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:

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 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.

rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source

The database connection string.

rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source

The ARN of the AWS credentials.

S3DestinationConfiguration

data S3DestinationConfiguration Source

Describes the configuration of a destination in Amazon S3.

See: s3DestinationConfiguration smart constructor.

Instances

s3DestinationConfiguration Source

Arguments

:: Text

sdcRoleARN

-> Text

sdcBucketARN

-> S3DestinationConfiguration 

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 guide-fh-dev.

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.

Instances

s3DestinationDescription Source

Arguments

:: Text

sddRoleARN

-> Text

sddBucketARN

-> BufferingHints

sddBufferingHints

-> CompressionFormat

sddCompressionFormat

-> EncryptionConfiguration

sddEncryptionConfiguration

-> 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 guide-fh-dev.

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.

Instances

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 guide-fh-dev.

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.