Struct aws_sdk_firehose::client::fluent_builders::PutRecordBatch
source · [−]pub struct PutRecordBatch { /* private fields */ }
Expand description
Fluent builder constructing a request to PutRecordBatch
.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord
. Applications using these operations are referred to as producers.
For information about service quota, see Amazon Kinesis Data Firehose Quota.
Each PutRecordBatch
request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the delivery stream and the data record when using PutRecord
. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could 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 PutRecordBatch
response includes a count of failed records, FailedPutCount
, and an array of responses, RequestResponses
. Even if the PutRecordBatch
call succeeds, the value of FailedPutCount
may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses
array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses
includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch
request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId
value, which is unique for the record. An unsuccessfully processed record includes ErrorCode
and ErrorMessage
values. ErrorCode
reflects the type of error, and is one of the following values: ServiceUnavailableException
or InternalFailure
. ErrorMessage
provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount
is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch
throws 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 attempts 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.
Implementations
sourceimpl PutRecordBatch
impl PutRecordBatch
sourcepub async fn send(
self
) -> Result<PutRecordBatchOutput, SdkError<PutRecordBatchError>>
pub async fn send(
self
) -> Result<PutRecordBatchOutput, SdkError<PutRecordBatchError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn delivery_stream_name(self, input: impl Into<String>) -> Self
pub fn delivery_stream_name(self, input: impl Into<String>) -> Self
The name of the delivery stream.
sourcepub fn set_delivery_stream_name(self, input: Option<String>) -> Self
pub fn set_delivery_stream_name(self, input: Option<String>) -> Self
The name of the delivery stream.
sourcepub fn records(self, input: Record) -> Self
pub fn records(self, input: Record) -> Self
Appends an item to Records
.
To override the contents of this collection use set_records
.
One or more records.
sourcepub fn set_records(self, input: Option<Vec<Record>>) -> Self
pub fn set_records(self, input: Option<Vec<Record>>) -> Self
One or more records.
Trait Implementations
sourceimpl Clone for PutRecordBatch
impl Clone for PutRecordBatch
sourcefn clone(&self) -> PutRecordBatch
fn clone(&self) -> PutRecordBatch
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for PutRecordBatch
impl Send for PutRecordBatch
impl Sync for PutRecordBatch
impl Unpin for PutRecordBatch
impl !UnwindSafe for PutRecordBatch
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more