aws_sdk_honeycode/client/batch_create_table_rows.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 [`BatchCreateTableRows`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`workbook_id(impl Into<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::workbook_id) / [`set_workbook_id(Option<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::set_workbook_id):<br>required: **true**<br><p>The ID of the workbook where the new rows are being added.</p> <p>If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.</p><br>
7 /// - [`table_id(impl Into<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::table_id) / [`set_table_id(Option<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::set_table_id):<br>required: **true**<br><p>The ID of the table where the new rows are being added.</p> <p>If a table with the specified ID could not be found, this API throws ResourceNotFoundException.</p><br>
8 /// - [`rows_to_create(CreateRowData)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::rows_to_create) / [`set_rows_to_create(Option<Vec::<CreateRowData>>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::set_rows_to_create):<br>required: **true**<br><p>The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.</p> <p>Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.</p><br>
9 /// - [`client_request_token(impl Into<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::set_client_request_token):<br>required: **false**<br><p>The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again.</p> <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p><br>
10 /// - On success, responds with [`BatchCreateTableRowsOutput`](crate::operation::batch_create_table_rows::BatchCreateTableRowsOutput) with field(s):
11 /// - [`workbook_cursor(i64)`](crate::operation::batch_create_table_rows::BatchCreateTableRowsOutput::workbook_cursor): <p>The updated workbook cursor after adding the new rows at the end of the table.</p>
12 /// - [`created_rows(HashMap::<String, String>)`](crate::operation::batch_create_table_rows::BatchCreateTableRowsOutput::created_rows): <p>The map of batch item id to the row id that was created for that item.</p>
13 /// - [`failed_batch_items(Option<Vec::<FailedBatchItem>>)`](crate::operation::batch_create_table_rows::BatchCreateTableRowsOutput::failed_batch_items): <p>The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.</p>
14 /// - On failure, responds with [`SdkError<BatchCreateTableRowsError>`](crate::operation::batch_create_table_rows::BatchCreateTableRowsError)
15 pub fn batch_create_table_rows(&self) -> crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder {
16 crate::operation::batch_create_table_rows::builders::BatchCreateTableRowsFluentBuilder::new(self.handle.clone())
17 }
18}