aws_sdk_timestreamwrite/client/write_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 [`WriteRecords`](crate::operation::write_records::builders::WriteRecordsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`database_name(impl Into<String>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::set_database_name):<br>required: **true**<br><p>The name of the Timestream database.</p><br>
7 /// - [`table_name(impl Into<String>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::table_name) / [`set_table_name(Option<String>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::set_table_name):<br>required: **true**<br><p>The name of the Timestream table.</p><br>
8 /// - [`common_attributes(Record)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::common_attributes) / [`set_common_attributes(Option<Record>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::set_common_attributes):<br>required: **false**<br><p>A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a <code>ValidationException</code> will be thrown. In other words, a record must contain dimensions with unique names.</p><br>
9 /// - [`records(Record)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::records) / [`set_records(Option<Vec::<Record>>)`](crate::operation::write_records::builders::WriteRecordsFluentBuilder::set_records):<br>required: **true**<br><p>An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.</p><br>
10 /// - On success, responds with [`WriteRecordsOutput`](crate::operation::write_records::WriteRecordsOutput) with field(s):
11 /// - [`records_ingested(Option<RecordsIngested>)`](crate::operation::write_records::WriteRecordsOutput::records_ingested): <p>Information on the records ingested by this request.</p>
12 /// - On failure, responds with [`SdkError<WriteRecordsError>`](crate::operation::write_records::WriteRecordsError)
13 pub fn write_records(&self) -> crate::operation::write_records::builders::WriteRecordsFluentBuilder {
14 crate::operation::write_records::builders::WriteRecordsFluentBuilder::new(self.handle.clone())
15 }
16}