aws_sdk_dynamodb/operation/
transact_write_items.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `TransactWriteItems`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct TransactWriteItems;
6impl TransactWriteItems {
7    /// Creates a new `TransactWriteItems`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::transact_write_items::TransactWriteItemsInput,
14    ) -> ::std::result::Result<
15        crate::operation::transact_write_items::TransactWriteItemsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::transact_write_items::TransactWriteItemsError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::transact_write_items::TransactWriteItemsError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::transact_write_items::TransactWriteItemsOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::transact_write_items::TransactWriteItemsInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("DynamoDB", "TransactWriteItems", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "DynamoDB.TransactWriteItems",
59                "rpc.service" = "DynamoDB",
60                "rpc.method" = "TransactWriteItems",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73        runtime_plugins = runtime_plugins
74            .with_operation_plugin(crate::client_idempotency_token::IdempotencyTokenRuntimePlugin::new(
75                |token_provider, input| {
76                    let input: &mut crate::operation::transact_write_items::TransactWriteItemsInput = input.downcast_mut().expect("correct type");
77                    if input.client_request_token.is_none() {
78                        input.client_request_token = ::std::option::Option::Some(token_provider.make_idempotency_token());
79                    }
80                },
81            ))
82            .with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
83                ::aws_runtime::auth::sigv4::SCHEME_ID,
84            ]));
85        if let ::std::option::Option::Some(config_override) = config_override {
86            for plugin in config_override.runtime_plugins.iter().cloned() {
87                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
88            }
89            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
90                config_override,
91                client_config.config.clone(),
92                &client_config.runtime_components,
93            ));
94        }
95        runtime_plugins
96    }
97}
98impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for TransactWriteItems {
99    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
100        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("TransactWriteItems");
101
102        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
103            TransactWriteItemsRequestSerializer,
104        ));
105        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
106            TransactWriteItemsResponseDeserializer,
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
110            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
111        ));
112
113        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
114            "TransactWriteItems",
115            "DynamoDB",
116        ));
117        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
118        signing_options.double_uri_encode = true;
119        signing_options.content_sha256_header = false;
120        signing_options.normalize_uri_path = true;
121        signing_options.payload_override = None;
122
123        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
124            signing_options,
125            ..::std::default::Default::default()
126        });
127
128        ::std::option::Option::Some(cfg.freeze())
129    }
130
131    fn runtime_components(
132        &self,
133        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
134    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
135        #[allow(unused_mut)]
136        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("TransactWriteItems")
137            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
138            .with_interceptor(TransactWriteItemsEndpointParamsInterceptor)
139            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
140                crate::operation::transact_write_items::TransactWriteItemsError,
141            >::new())
142            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
143                crate::operation::transact_write_items::TransactWriteItemsError,
144            >::new())
145            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
146                crate::operation::transact_write_items::TransactWriteItemsError,
147            >::new());
148
149        ::std::borrow::Cow::Owned(rcb)
150    }
151}
152
153#[derive(Debug)]
154struct TransactWriteItemsResponseDeserializer;
155impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for TransactWriteItemsResponseDeserializer {
156    fn deserialize_nonstreaming(
157        &self,
158        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
159    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
160        let (success, status) = (response.status().is_success(), response.status().as_u16());
161        let headers = response.headers();
162        let body = response.body().bytes().expect("body loaded");
163        #[allow(unused_mut)]
164        let mut force_error = false;
165        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
166        let parse_result = if !success && status != 200 || force_error {
167            crate::protocol_serde::shape_transact_write_items::de_transact_write_items_http_error(status, headers, body)
168        } else {
169            crate::protocol_serde::shape_transact_write_items::de_transact_write_items_http_response(status, headers, body)
170        };
171        crate::protocol_serde::type_erase_result(parse_result)
172    }
173}
174#[derive(Debug)]
175struct TransactWriteItemsRequestSerializer;
176impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for TransactWriteItemsRequestSerializer {
177    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
178    fn serialize_input(
179        &self,
180        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
181        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
182    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
183        let input = input
184            .downcast::<crate::operation::transact_write_items::TransactWriteItemsInput>()
185            .expect("correct type");
186        let _header_serialization_settings = _cfg
187            .load::<crate::serialization_settings::HeaderSerializationSettings>()
188            .cloned()
189            .unwrap_or_default();
190        let mut request_builder = {
191            fn uri_base(
192                _input: &crate::operation::transact_write_items::TransactWriteItemsInput,
193                output: &mut ::std::string::String,
194            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
195                use ::std::fmt::Write as _;
196                ::std::write!(output, "/").expect("formatting should succeed");
197                ::std::result::Result::Ok(())
198            }
199            #[allow(clippy::unnecessary_wraps)]
200            fn update_http_builder(
201                input: &crate::operation::transact_write_items::TransactWriteItemsInput,
202                builder: ::http::request::Builder,
203            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
204                let mut uri = ::std::string::String::new();
205                uri_base(input, &mut uri)?;
206                ::std::result::Result::Ok(builder.method("POST").uri(uri))
207            }
208            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
209            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
210            builder = _header_serialization_settings.set_default_header(
211                builder,
212                ::http::header::HeaderName::from_static("x-amz-target"),
213                "DynamoDB_20120810.TransactWriteItems",
214            );
215            builder
216        };
217        let body =
218            ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_transact_write_items::ser_transact_write_items_input(&input)?);
219        if let Some(content_length) = body.content_length() {
220            let content_length = content_length.to_string();
221            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
222        }
223        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
224    }
225}
226#[derive(Debug)]
227struct TransactWriteItemsEndpointParamsInterceptor;
228
229impl ::aws_smithy_runtime_api::client::interceptors::Intercept for TransactWriteItemsEndpointParamsInterceptor {
230    fn name(&self) -> &'static str {
231        "TransactWriteItemsEndpointParamsInterceptor"
232    }
233
234    fn read_before_execution(
235        &self,
236        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
237            '_,
238            ::aws_smithy_runtime_api::client::interceptors::context::Input,
239            ::aws_smithy_runtime_api::client::interceptors::context::Output,
240            ::aws_smithy_runtime_api::client::interceptors::context::Error,
241        >,
242        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
243    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
244        let _input = context
245            .input()
246            .downcast_ref::<TransactWriteItemsInput>()
247            .ok_or("failed to downcast to TransactWriteItemsInput")?;
248
249        let params = crate::config::endpoint::Params::builder()
250            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
251            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
252            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
253            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
254            .set_account_id_endpoint_mode(::std::option::Option::Some(
255                cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>()
256                    .cloned()
257                    .unwrap_or_default()
258                    .to_string(),
259            ))
260            .set_resource_arn_list(get_resource_arn_list(_input).map(|v| v.into_iter().cloned().collect::<Vec<_>>()))
261            .build()
262            .map_err(|err| {
263                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
264            })?;
265        cfg.interceptor_state()
266            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
267        ::std::result::Result::Ok(())
268    }
269}
270
271// The get_* functions below are generated from JMESPath expressions in the
272// operationContextParams trait. They target the operation's input shape.
273
274// Generated from JMESPath Expression: TransactItems[*].[ConditionCheck.TableName, Put.TableName, Delete.TableName, Update.TableName][]
275fn get_resource_arn_list(input: &crate::operation::transact_write_items::TransactWriteItemsInput) -> Option<::std::vec::Vec<&::std::string::String>> {
276    let _fld_1 = input.transact_items.as_ref()?;
277    let _prj_11 = _fld_1
278        .iter()
279        .flat_map(|v| {
280            #[allow(clippy::let_and_return)]
281            fn map(_v: &crate::types::TransactWriteItem) -> ::std::option::Option<::std::vec::Vec<::std::option::Option<&::std::string::String>>> {
282                let _fld_2 = _v.condition_check.as_ref();
283                let _fld_3 = _fld_2.map(|v| &v.table_name);
284                let _fld_4 = _v.put.as_ref();
285                let _fld_5 = _fld_4.map(|v| &v.table_name);
286                let _fld_6 = _v.delete.as_ref();
287                let _fld_7 = _fld_6.map(|v| &v.table_name);
288                let _fld_8 = _v.update.as_ref();
289                let _fld_9 = _fld_8.map(|v| &v.table_name);
290                let _msl_10 = vec![_fld_3, _fld_5, _fld_7, _fld_9];
291                ::std::option::Option::Some(_msl_10)
292            }
293            map(v)
294        })
295        .flatten()
296        .flatten()
297        .collect::<::std::vec::Vec<_>>();
298    Some(_prj_11)
299}
300
301/// Error type for the `TransactWriteItemsError` operation.
302#[non_exhaustive]
303#[derive(::std::fmt::Debug)]
304pub enum TransactWriteItemsError {
305    /// <p>DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.</p>
306    IdempotentParameterMismatchException(crate::types::error::IdempotentParameterMismatchException),
307    /// <p>An error occurred on the server side.</p>
308    InternalServerError(crate::types::error::InternalServerError),
309    #[allow(missing_docs)] // documentation missing in model
310    InvalidEndpointException(crate::types::error::InvalidEndpointException),
311    /// <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
312    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
313    /// <p>Throughput exceeds the current throughput quota for your account. Please contact <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a quota increase.</p>
314    RequestLimitExceeded(crate::types::error::RequestLimitExceeded),
315    /// <p>The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
316    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
317    /// <p>The entire transaction request was canceled.</p>
318    /// <p>DynamoDB cancels a <code>TransactWriteItems</code> request under the following circumstances:</p>
319    /// <ul>
320    /// <li>
321    /// <p>A condition in one of the condition expressions is not met.</p></li>
322    /// <li>
323    /// <p>A table in the <code>TransactWriteItems</code> request is in a different account or region.</p></li>
324    /// <li>
325    /// <p>More than one action in the <code>TransactWriteItems</code> operation targets the same item.</p></li>
326    /// <li>
327    /// <p>There is insufficient provisioned capacity for the transaction to be completed.</p></li>
328    /// <li>
329    /// <p>An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.</p></li>
330    /// <li>
331    /// <p>There is a user error, such as an invalid data format.</p></li>
332    /// <li>
333    /// <p>There is an ongoing <code>TransactWriteItems</code> operation that conflicts with a concurrent <code>TransactWriteItems</code> request. In this case the <code>TransactWriteItems</code> operation fails with a <code>TransactionCanceledException</code>.</p></li>
334    /// </ul>
335    /// <p>DynamoDB cancels a <code>TransactGetItems</code> request under the following circumstances:</p>
336    /// <ul>
337    /// <li>
338    /// <p>There is an ongoing <code>TransactGetItems</code> operation that conflicts with a concurrent <code>PutItem</code>, <code>UpdateItem</code>, <code>DeleteItem</code> or <code>TransactWriteItems</code> request. In this case the <code>TransactGetItems</code> operation fails with a <code>TransactionCanceledException</code>.</p></li>
339    /// <li>
340    /// <p>A table in the <code>TransactGetItems</code> request is in a different account or region.</p></li>
341    /// <li>
342    /// <p>There is insufficient provisioned capacity for the transaction to be completed.</p></li>
343    /// <li>
344    /// <p>There is a user error, such as an invalid data format.</p></li>
345    /// </ul><note>
346    /// <p>If using Java, DynamoDB lists the cancellation reasons on the <code>CancellationReasons</code> property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have <code>None</code> code and <code>Null</code> message.</p>
347    /// </note>
348    /// <p>Cancellation reason codes and possible error messages:</p>
349    /// <ul>
350    /// <li>
351    /// <p>No Errors:</p>
352    /// <ul>
353    /// <li>
354    /// <p>Code: <code>None</code></p></li>
355    /// <li>
356    /// <p>Message: <code>null</code></p></li>
357    /// </ul></li>
358    /// <li>
359    /// <p>Conditional Check Failed:</p>
360    /// <ul>
361    /// <li>
362    /// <p>Code: <code>ConditionalCheckFailed</code></p></li>
363    /// <li>
364    /// <p>Message: The conditional request failed.</p></li>
365    /// </ul></li>
366    /// <li>
367    /// <p>Item Collection Size Limit Exceeded:</p>
368    /// <ul>
369    /// <li>
370    /// <p>Code: <code>ItemCollectionSizeLimitExceeded</code></p></li>
371    /// <li>
372    /// <p>Message: Collection size exceeded.</p></li>
373    /// </ul></li>
374    /// <li>
375    /// <p>Transaction Conflict:</p>
376    /// <ul>
377    /// <li>
378    /// <p>Code: <code>TransactionConflict</code></p></li>
379    /// <li>
380    /// <p>Message: Transaction is ongoing for the item.</p></li>
381    /// </ul></li>
382    /// <li>
383    /// <p>Provisioned Throughput Exceeded:</p>
384    /// <ul>
385    /// <li>
386    /// <p>Code: <code>ProvisionedThroughputExceeded</code></p></li>
387    /// <li>
388    /// <p>Messages:</p>
389    /// <ul>
390    /// <li>
391    /// <p>The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.</p><note>
392    /// <p>This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.</p>
393    /// </note></li>
394    /// <li>
395    /// <p>The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.</p><note>
396    /// <p>This message is returned when provisioned throughput is exceeded is on a provisioned GSI.</p>
397    /// </note></li>
398    /// </ul></li>
399    /// </ul></li>
400    /// <li>
401    /// <p>Throttling Error:</p>
402    /// <ul>
403    /// <li>
404    /// <p>Code: <code>ThrottlingError</code></p></li>
405    /// <li>
406    /// <p>Messages:</p>
407    /// <ul>
408    /// <li>
409    /// <p>Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.</p><note>
410    /// <p>This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.</p>
411    /// </note></li>
412    /// <li>
413    /// <p>Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.</p><note>
414    /// <p>This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.</p>
415    /// </note></li>
416    /// </ul></li>
417    /// </ul></li>
418    /// <li>
419    /// <p>Validation Error:</p>
420    /// <ul>
421    /// <li>
422    /// <p>Code: <code>ValidationError</code></p></li>
423    /// <li>
424    /// <p>Messages:</p>
425    /// <ul>
426    /// <li>
427    /// <p>One or more parameter values were invalid.</p></li>
428    /// <li>
429    /// <p>The update expression attempted to update the secondary index key beyond allowed size limits.</p></li>
430    /// <li>
431    /// <p>The update expression attempted to update the secondary index key to unsupported type.</p></li>
432    /// <li>
433    /// <p>An operand in the update expression has an incorrect data type.</p></li>
434    /// <li>
435    /// <p>Item size to update has exceeded the maximum allowed size.</p></li>
436    /// <li>
437    /// <p>Number overflow. Attempting to store a number with magnitude larger than supported range.</p></li>
438    /// <li>
439    /// <p>Type mismatch for attribute to update.</p></li>
440    /// <li>
441    /// <p>Nesting Levels have exceeded supported limits.</p></li>
442    /// <li>
443    /// <p>The document path provided in the update expression is invalid for update.</p></li>
444    /// <li>
445    /// <p>The provided expression refers to an attribute that does not exist in the item.</p></li>
446    /// </ul></li>
447    /// </ul></li>
448    /// </ul>
449    TransactionCanceledException(crate::types::error::TransactionCanceledException),
450    /// <p>The transaction with the given request token is already in progress.</p>
451    /// <p>Recommended Settings</p><note>
452    /// <p>This is a general recommendation for handling the <code>TransactionInProgressException</code>. These settings help ensure that the client retries will trigger completion of the ongoing <code>TransactWriteItems</code> request.</p>
453    /// </note>
454    /// <ul>
455    /// <li>
456    /// <p>Set <code>clientExecutionTimeout</code> to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the <code>TransactWriteItems</code> operation.</p></li>
457    /// <li>
458    /// <p>Set <code>socketTimeout</code> to a value a little lower than the <code>requestTimeout</code> setting.</p></li>
459    /// <li>
460    /// <p><code>requestTimeout</code> should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and <code>TransactionInProgressException</code> errors.</p></li>
461    /// <li>
462    /// <p>Use exponential backoff when retrying and tune backoff if needed.</p></li>
463    /// </ul>
464    /// <p>Assuming <a href="https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97">default retry policy</a>, example timeout settings based on the guidelines above are as follows:</p>
465    /// <p>Example timeline:</p>
466    /// <ul>
467    /// <li>
468    /// <p>0-1000 first attempt</p></li>
469    /// <li>
470    /// <p>1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)</p></li>
471    /// <li>
472    /// <p>1500-2500 second attempt</p></li>
473    /// <li>
474    /// <p>2500-3500 second sleep/delay (500 * 2, exponential backoff)</p></li>
475    /// <li>
476    /// <p>3500-4500 third attempt</p></li>
477    /// <li>
478    /// <p>4500-6500 third sleep/delay (500 * 2^2)</p></li>
479    /// <li>
480    /// <p>6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)</p></li>
481    /// </ul>
482    TransactionInProgressException(crate::types::error::TransactionInProgressException),
483    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
484    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
485    variable wildcard pattern and check `.code()`:
486     \
487    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
488     \
489    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-TransactWriteItemsError) for what information is available for the error.")]
490    Unhandled(crate::error::sealed_unhandled::Unhandled),
491}
492impl TransactWriteItemsError {
493    /// Creates the `TransactWriteItemsError::Unhandled` variant from any error type.
494    pub fn unhandled(
495        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
496    ) -> Self {
497        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
498            source: err.into(),
499            meta: ::std::default::Default::default(),
500        })
501    }
502
503    /// Creates the `TransactWriteItemsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
504    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
505        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
506            source: err.clone().into(),
507            meta: err,
508        })
509    }
510    ///
511    /// Returns error metadata, which includes the error code, message,
512    /// request ID, and potentially additional information.
513    ///
514    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
515        match self {
516            Self::IdempotentParameterMismatchException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
517            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
518            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
519            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
520            Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
521            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
522            Self::TransactionCanceledException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
523            Self::TransactionInProgressException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
524            Self::Unhandled(e) => &e.meta,
525        }
526    }
527    /// Returns `true` if the error kind is `TransactWriteItemsError::IdempotentParameterMismatchException`.
528    pub fn is_idempotent_parameter_mismatch_exception(&self) -> bool {
529        matches!(self, Self::IdempotentParameterMismatchException(_))
530    }
531    /// Returns `true` if the error kind is `TransactWriteItemsError::InternalServerError`.
532    pub fn is_internal_server_error(&self) -> bool {
533        matches!(self, Self::InternalServerError(_))
534    }
535    /// Returns `true` if the error kind is `TransactWriteItemsError::InvalidEndpointException`.
536    pub fn is_invalid_endpoint_exception(&self) -> bool {
537        matches!(self, Self::InvalidEndpointException(_))
538    }
539    /// Returns `true` if the error kind is `TransactWriteItemsError::ProvisionedThroughputExceededException`.
540    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
541        matches!(self, Self::ProvisionedThroughputExceededException(_))
542    }
543    /// Returns `true` if the error kind is `TransactWriteItemsError::RequestLimitExceeded`.
544    pub fn is_request_limit_exceeded(&self) -> bool {
545        matches!(self, Self::RequestLimitExceeded(_))
546    }
547    /// Returns `true` if the error kind is `TransactWriteItemsError::ResourceNotFoundException`.
548    pub fn is_resource_not_found_exception(&self) -> bool {
549        matches!(self, Self::ResourceNotFoundException(_))
550    }
551    /// Returns `true` if the error kind is `TransactWriteItemsError::TransactionCanceledException`.
552    pub fn is_transaction_canceled_exception(&self) -> bool {
553        matches!(self, Self::TransactionCanceledException(_))
554    }
555    /// Returns `true` if the error kind is `TransactWriteItemsError::TransactionInProgressException`.
556    pub fn is_transaction_in_progress_exception(&self) -> bool {
557        matches!(self, Self::TransactionInProgressException(_))
558    }
559}
560impl ::std::error::Error for TransactWriteItemsError {
561    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
562        match self {
563            Self::IdempotentParameterMismatchException(_inner) => ::std::option::Option::Some(_inner),
564            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
565            Self::InvalidEndpointException(_inner) => ::std::option::Option::Some(_inner),
566            Self::ProvisionedThroughputExceededException(_inner) => ::std::option::Option::Some(_inner),
567            Self::RequestLimitExceeded(_inner) => ::std::option::Option::Some(_inner),
568            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
569            Self::TransactionCanceledException(_inner) => ::std::option::Option::Some(_inner),
570            Self::TransactionInProgressException(_inner) => ::std::option::Option::Some(_inner),
571            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
572        }
573    }
574}
575impl ::std::fmt::Display for TransactWriteItemsError {
576    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
577        match self {
578            Self::IdempotentParameterMismatchException(_inner) => _inner.fmt(f),
579            Self::InternalServerError(_inner) => _inner.fmt(f),
580            Self::InvalidEndpointException(_inner) => _inner.fmt(f),
581            Self::ProvisionedThroughputExceededException(_inner) => _inner.fmt(f),
582            Self::RequestLimitExceeded(_inner) => _inner.fmt(f),
583            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
584            Self::TransactionCanceledException(_inner) => _inner.fmt(f),
585            Self::TransactionInProgressException(_inner) => _inner.fmt(f),
586            Self::Unhandled(_inner) => {
587                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
588                    write!(f, "unhandled error ({code})")
589                } else {
590                    f.write_str("unhandled error")
591                }
592            }
593        }
594    }
595}
596impl ::aws_smithy_types::retry::ProvideErrorKind for TransactWriteItemsError {
597    fn code(&self) -> ::std::option::Option<&str> {
598        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
599    }
600    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
601        ::std::option::Option::None
602    }
603}
604impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for TransactWriteItemsError {
605    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
606        match self {
607            Self::IdempotentParameterMismatchException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
608            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
609            Self::InvalidEndpointException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
610            Self::ProvisionedThroughputExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
611            Self::RequestLimitExceeded(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
612            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
613            Self::TransactionCanceledException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
614            Self::TransactionInProgressException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
615            Self::Unhandled(_inner) => &_inner.meta,
616        }
617    }
618}
619impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for TransactWriteItemsError {
620    fn create_unhandled_error(
621        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
622        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
623    ) -> Self {
624        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
625            source,
626            meta: meta.unwrap_or_default(),
627        })
628    }
629}
630impl ::aws_types::request_id::RequestId for crate::operation::transact_write_items::TransactWriteItemsError {
631    fn request_id(&self) -> Option<&str> {
632        self.meta().request_id()
633    }
634}
635
636pub use crate::operation::transact_write_items::_transact_write_items_output::TransactWriteItemsOutput;
637
638pub use crate::operation::transact_write_items::_transact_write_items_input::TransactWriteItemsInput;
639
640mod _transact_write_items_input;
641
642mod _transact_write_items_output;
643
644/// Builders
645pub mod builders;
aws_sdk_dynamodb/operation/transact_write_items.rs

aws_sdk_dynamodb/operation/
transact_write_items.rs
