aws_sdk_dynamodb/operation/batch_execute_statement/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_execute_statement::_batch_execute_statement_output::BatchExecuteStatementOutputBuilder;
3
4pub use crate::operation::batch_execute_statement::_batch_execute_statement_input::BatchExecuteStatementInputBuilder;
5
6impl crate::operation::batch_execute_statement::builders::BatchExecuteStatementInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::batch_execute_statement::BatchExecuteStatementOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_execute_statement::BatchExecuteStatementError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_execute_statement();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchExecuteStatement`.
24///
25/// <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify an equality condition on all key attributes. This enforces that each <code>SELECT</code> statement in a batch returns at most a single item. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html">Running batch operations with PartiQL for DynamoDB </a>.</p><note>
26/// <p>The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.</p>
27/// </note> <important>
28/// <p>A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error">Error</a> field of the <code>BatchStatementResponse</code> for each statement.</p>
29/// </important>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct BatchExecuteStatementFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::batch_execute_statement::builders::BatchExecuteStatementInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::batch_execute_statement::BatchExecuteStatementOutput,
39        crate::operation::batch_execute_statement::BatchExecuteStatementError,
40    > for BatchExecuteStatementFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::batch_execute_statement::BatchExecuteStatementOutput,
48            crate::operation::batch_execute_statement::BatchExecuteStatementError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl BatchExecuteStatementFluentBuilder {
55    /// Creates a new `BatchExecuteStatementFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the BatchExecuteStatement as a reference.
64    pub fn as_input(&self) -> &crate::operation::batch_execute_statement::builders::BatchExecuteStatementInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::batch_execute_statement::BatchExecuteStatementOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::batch_execute_statement::BatchExecuteStatementError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::batch_execute_statement::BatchExecuteStatement::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::batch_execute_statement::BatchExecuteStatement::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::batch_execute_statement::BatchExecuteStatementOutput,
101        crate::operation::batch_execute_statement::BatchExecuteStatementError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    ///
116    /// Appends an item to `Statements`.
117    ///
118    /// To override the contents of this collection use [`set_statements`](Self::set_statements).
119    ///
120    /// <p>The list of PartiQL statements representing the batch to run.</p>
121    pub fn statements(mut self, input: crate::types::BatchStatementRequest) -> Self {
122        self.inner = self.inner.statements(input);
123        self
124    }
125    /// <p>The list of PartiQL statements representing the batch to run.</p>
126    pub fn set_statements(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>>) -> Self {
127        self.inner = self.inner.set_statements(input);
128        self
129    }
130    /// <p>The list of PartiQL statements representing the batch to run.</p>
131    pub fn get_statements(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>> {
132        self.inner.get_statements()
133    }
134    /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
135    /// <ul>
136    /// <li>
137    /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
138    /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
139    /// <li>
140    /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
141    /// <li>
142    /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
143    /// </ul>
144    pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
145        self.inner = self.inner.return_consumed_capacity(input);
146        self
147    }
148    /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
149    /// <ul>
150    /// <li>
151    /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
152    /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
153    /// <li>
154    /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
155    /// <li>
156    /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
157    /// </ul>
158    pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
159        self.inner = self.inner.set_return_consumed_capacity(input);
160        self
161    }
162    /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
163    /// <ul>
164    /// <li>
165    /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
166    /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
167    /// <li>
168    /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
169    /// <li>
170    /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
171    /// </ul>
172    pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
173        self.inner.get_return_consumed_capacity()
174    }
175}
aws_sdk_dynamodb/operation/batch_execute_statement/builders.rs

aws_sdk_dynamodb/operation/batch_execute_statement/
builders.rs
