aws_sdk_kinesis/client/put_records.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`PutRecords`](crate::operation::put_records::builders::PutRecordsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`records(PutRecordsRequestEntry)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::records) / [`set_records(Option<Vec::<PutRecordsRequestEntry>>)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::set_records):<br>required: **true**<br><p>The records associated with the request.</p><br>
7 /// - [`stream_name(impl Into<String>)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::stream_name) / [`set_stream_name(Option<String>)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::set_stream_name):<br>required: **false**<br><p>The stream name associated with the request.</p><br>
8 /// - [`stream_arn(impl Into<String>)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::put_records::builders::PutRecordsFluentBuilder::set_stream_arn):<br>required: **false**<br><p>The ARN of the stream.</p><br>
9 /// - On success, responds with [`PutRecordsOutput`](crate::operation::put_records::PutRecordsOutput) with field(s):
10 /// - [`failed_record_count(Option<i32>)`](crate::operation::put_records::PutRecordsOutput::failed_record_count): <p>The number of unsuccessfully processed records in a <code>PutRecords</code> request.</p>
11 /// - [`records(Vec::<PutRecordsResultEntry>)`](crate::operation::put_records::PutRecordsOutput::records): <p>An array of successfully and unsuccessfully processed record results. A record that is successfully added to a stream includes <code>SequenceNumber</code> and <code>ShardId</code> in the result. A record that fails to be added to a stream includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
12 /// - [`encryption_type(Option<EncryptionType>)`](crate::operation::put_records::PutRecordsOutput::encryption_type): <p>The encryption type used on the records. This parameter can be one of the following values:</p> <ul> <li> <p><code>NONE</code>: Do not encrypt the records.</p></li> <li> <p><code>KMS</code>: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.</p></li> </ul>
13 /// - On failure, responds with [`SdkError<PutRecordsError>`](crate::operation::put_records::PutRecordsError)
14 pub fn put_records(&self) -> crate::operation::put_records::builders::PutRecordsFluentBuilder {
15 crate::operation::put_records::builders::PutRecordsFluentBuilder::new(self.handle.clone())
16 }
17}