libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Firehose.PutRecord

Description

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

Synopsis

Creating a Request

data PutRecord Source #

See: newPutRecord smart constructor.

Constructors

PutRecord' 

Fields

Instances

Instances details
Eq PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Read PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Show PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Generic PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Associated Types

type Rep PutRecord :: Type -> Type #

NFData PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Methods

rnf :: PutRecord -> () #

Hashable PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

ToJSON PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

AWSRequest PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Associated Types

type AWSResponse PutRecord #

ToHeaders PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Methods

toHeaders :: PutRecord -> [Header] #

ToPath PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

ToQuery PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

type Rep PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

type Rep PutRecord = D1 ('MetaData "PutRecord" "Amazonka.Firehose.PutRecord" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "PutRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "record") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Record)))
type AWSResponse PutRecord Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

newPutRecord Source #

Create a value of PutRecord with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deliveryStreamName:PutRecord', putRecord_deliveryStreamName - The name of the delivery stream.

$sel:record:PutRecord', putRecord_record - The record.

Request Lenses

putRecord_deliveryStreamName :: Lens' PutRecord Text Source #

The name of the delivery stream.

Destructuring the Response

data PutRecordResponse Source #

See: newPutRecordResponse smart constructor.

Constructors

PutRecordResponse' 

Fields

Instances

Instances details
Eq PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Read PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Show PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Generic PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Associated Types

type Rep PutRecordResponse :: Type -> Type #

NFData PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

Methods

rnf :: PutRecordResponse -> () #

type Rep PutRecordResponse Source # 
Instance details

Defined in Amazonka.Firehose.PutRecord

type Rep PutRecordResponse = D1 ('MetaData "PutRecordResponse" "Amazonka.Firehose.PutRecord" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "PutRecordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "recordId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutRecordResponse Source #

Create a value of PutRecordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encrypted:PutRecordResponse', putRecordResponse_encrypted - Indicates whether server-side encryption (SSE) was enabled during this operation.

$sel:httpStatus:PutRecordResponse', putRecordResponse_httpStatus - The response's http status code.

$sel:recordId:PutRecordResponse', putRecordResponse_recordId - The ID of the record.

Response Lenses

putRecordResponse_encrypted :: Lens' PutRecordResponse (Maybe Bool) Source #

Indicates whether server-side encryption (SSE) was enabled during this operation.

putRecordResponse_httpStatus :: Lens' PutRecordResponse Int Source #

The response's http status code.