Struct aws_sdk_kinesis::client::fluent_builders::PutRecords
source · [−]pub struct PutRecords { /* private fields */ }
Expand description
Fluent builder constructing a request to PutRecords
.
Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords
request). Use this operation to send data into the stream for data ingestion and processing.
Each PutRecords
request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records
, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records
array may include an optional parameter, ExplicitHashKey
, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords
response includes an array of response Records
. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records
array always includes the same number of records as the request array.
The response Records
array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords
request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord
instead of PutRecords
, and write to the same shard.
A successfully processed record includes ShardId
and SequenceNumber
values. The ShardId
parameter identifies the shard in the stream where the record is stored. The SequenceNumber
parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode
and ErrorMessage
values. ErrorCode
reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException
or InternalFailure
. ErrorMessage
provides more detailed information about the ProvisionedThroughputExceededException
exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod
or DecreaseStreamRetentionPeriod
to modify this retention period.
Implementations
sourceimpl PutRecords
impl PutRecords
sourcepub async fn send(self) -> Result<PutRecordsOutput, SdkError<PutRecordsError>>
pub async fn send(self) -> Result<PutRecordsOutput, SdkError<PutRecordsError>>
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 records(self, input: PutRecordsRequestEntry) -> Self
pub fn records(self, input: PutRecordsRequestEntry) -> Self
Appends an item to Records
.
To override the contents of this collection use set_records
.
The records associated with the request.
sourcepub fn set_records(self, input: Option<Vec<PutRecordsRequestEntry>>) -> Self
pub fn set_records(self, input: Option<Vec<PutRecordsRequestEntry>>) -> Self
The records associated with the request.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The stream name associated with the request.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The stream name associated with the request.
Trait Implementations
sourceimpl Clone for PutRecords
impl Clone for PutRecords
sourcefn clone(&self) -> PutRecords
fn clone(&self) -> PutRecords
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 PutRecords
impl Send for PutRecords
impl Sync for PutRecords
impl Unpin for PutRecords
impl !UnwindSafe for PutRecords
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