aws_sdk_dynamodb/operation/
batch_get_item.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `BatchGetItem`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct BatchGetItem;
6impl BatchGetItem {
7    /// Creates a new `BatchGetItem`
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::batch_get_item::BatchGetItemInput,
14                    ) -> ::std::result::Result<crate::operation::batch_get_item::BatchGetItemOutput, ::aws_smithy_runtime_api::client::result::SdkError<crate::operation::batch_get_item::BatchGetItemError, ::aws_smithy_runtime_api::client::orchestrator::HttpResponse>> {
15                        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<::aws_smithy_runtime_api::client::interceptors::context::Error, ::aws_smithy_runtime_api::client::orchestrator::HttpResponse>| {
16                            err.map_service_error(|err| {
17                                err.downcast::<crate::operation::batch_get_item::BatchGetItemError>().expect("correct error type")
18                            })
19                        };
20                        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
21                            .await
22                            .map_err(map_err)?;
23                        let output = context.finalize().map_err(map_err)?;
24                        ::std::result::Result::Ok(output.downcast::<crate::operation::batch_get_item::BatchGetItemOutput>().expect("correct output type"))
25                    }
26    
27                    pub(crate) async fn orchestrate_with_stop_point(
28                        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
29                        input: crate::operation::batch_get_item::BatchGetItemInput,
30                        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
31                    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext, ::aws_smithy_runtime_api::client::result::SdkError<::aws_smithy_runtime_api::client::interceptors::context::Error, ::aws_smithy_runtime_api::client::orchestrator::HttpResponse>> {
32                        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
33                        use ::tracing::Instrument;
34                        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point(
35                            "DynamoDB",
36                            "BatchGetItem",
37                            input,
38                            runtime_plugins,
39                            stop_point
40                        )
41                        // Create a parent span for the entire operation. Includes a random, internal-only,
42                        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
43                        .instrument(::tracing::debug_span!(
44                                "DynamoDB.BatchGetItem",
45                                "rpc.service" = "DynamoDB",
46                                "rpc.method" = "BatchGetItem",
47                                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
48                                "rpc.system" = "aws-api",
49                            ))
50                        .await
51                    }
52    
53                    pub(crate) fn operation_runtime_plugins(
54                        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
55                        client_config: &crate::config::Config,
56                        config_override: ::std::option::Option<crate::config::Builder>,
57                    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
58                        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
59                        
60                        if let ::std::option::Option::Some(config_override) = config_override {
61                            for plugin in config_override.runtime_plugins.iter().cloned() {
62                                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
63                            }
64                            runtime_plugins = runtime_plugins.with_operation_plugin(
65                                crate::config::ConfigOverrideRuntimePlugin::new(config_override, client_config.config.clone(), &client_config.runtime_components)
66                            );
67                        }
68                        runtime_plugins
69                    }
70}
71impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for BatchGetItem {
72                fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
73                    let mut cfg = ::aws_smithy_types::config_bag::Layer::new("BatchGetItem");
74
75                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(BatchGetItemRequestSerializer));
76                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(BatchGetItemResponseDeserializer));
77
78                    cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
79                        crate::config::auth::Params::builder()
80                            .operation_name("BatchGetItem")
81                            .build()
82                            .expect("required fields set")
83                    ));
84
85                    cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
86                            "BatchGetItem",
87                            "DynamoDB",
88                        ));
89let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
90                            signing_options.double_uri_encode = true;
91                            signing_options.content_sha256_header = false;
92                            signing_options.normalize_uri_path = true;
93                            signing_options.payload_override = None;
94
95                            cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
96                                signing_options,
97                                ..::std::default::Default::default()
98                            });
99
100                    ::std::option::Option::Some(cfg.freeze())
101                }
102
103                fn runtime_components(&self, _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
104                    #[allow(unused_mut)]
105                    let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("BatchGetItem")
106                            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
107.with_interceptor(BatchGetItemEndpointParamsInterceptor)
108                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::batch_get_item::BatchGetItemError>::new())
109.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::batch_get_item::BatchGetItemError>::new())
110.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::batch_get_item::BatchGetItemError>::new());
111
112                    ::std::borrow::Cow::Owned(rcb)
113                }
114            }
115
116            
117#[derive(Debug)]
118            struct BatchGetItemResponseDeserializer;
119            impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for BatchGetItemResponseDeserializer {
120                
121
122                fn deserialize_nonstreaming(&self, response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
123                    let (success, status) = (response.status().is_success(), response.status().as_u16());
124            let headers = response.headers();
125            let body = response.body().bytes().expect("body loaded");
126            #[allow(unused_mut)]
127            let mut force_error = false;
128            ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
129            let parse_result = if !success && status != 200 || force_error {
130                crate::protocol_serde::shape_batch_get_item::de_batch_get_item_http_error(status, headers, body)
131            } else {
132                crate::protocol_serde::shape_batch_get_item::de_batch_get_item_http_response(status, headers, body)
133            };
134            crate::protocol_serde::type_erase_result(parse_result)
135                }
136            }
137#[derive(Debug)]
138            struct BatchGetItemRequestSerializer;
139            impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for BatchGetItemRequestSerializer {
140                #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
141                fn serialize_input(&self, input: ::aws_smithy_runtime_api::client::interceptors::context::Input, _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
142                    let input = input.downcast::<crate::operation::batch_get_item::BatchGetItemInput>().expect("correct type");
143                    let _header_serialization_settings = _cfg.load::<crate::serialization_settings::HeaderSerializationSettings>().cloned().unwrap_or_default();
144                    let mut request_builder = {
145                        fn uri_base(_input: &crate::operation::batch_get_item::BatchGetItemInput, output: &mut ::std::string::String) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
146    use ::std::fmt::Write as _;
147    ::std::write!(output, "/").expect("formatting should succeed");
148    ::std::result::Result::Ok(())
149}
150#[allow(clippy::unnecessary_wraps)]
151fn update_http_builder(
152                input: &crate::operation::batch_get_item::BatchGetItemInput,
153                builder: ::http::request::Builder
154            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
155    let mut uri = ::std::string::String::new();
156    uri_base(input, &mut uri)?;
157    ::std::result::Result::Ok(builder.method("POST").uri(uri))
158}
159let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
160builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
161builder = _header_serialization_settings.set_default_header(
162                        builder,
163                        ::http::header::HeaderName::from_static("x-amz-target"),
164                        "DynamoDB_20120810.BatchGetItem"
165                    );
166builder
167                    };
168                    let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_batch_get_item::ser_batch_get_item_input(&input)?);
169                    if let Some(content_length) = body.content_length() {
170                                let content_length = content_length.to_string();
171                                request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
172                            }
173                    ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
174                }
175            }
176#[derive(Debug)]
177            struct BatchGetItemEndpointParamsInterceptor;
178
179            impl ::aws_smithy_runtime_api::client::interceptors::Intercept for BatchGetItemEndpointParamsInterceptor {
180                fn name(&self) -> &'static str {
181                    "BatchGetItemEndpointParamsInterceptor"
182                }
183
184                fn read_before_execution(
185                    &self,
186                    context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<'_, ::aws_smithy_runtime_api::client::interceptors::context::Input, ::aws_smithy_runtime_api::client::interceptors::context::Output, ::aws_smithy_runtime_api::client::interceptors::context::Error>,
187                    cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
188                ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
189                    let _input = context.input()
190                        .downcast_ref::<BatchGetItemInput>()
191                        .ok_or("failed to downcast to BatchGetItemInput")?;
192
193                    
194
195                    let params = crate::config::endpoint::Params::builder()
196                        .set_region(cfg.load::<::aws_types::region::Region>().map(|r|r.as_ref().to_owned()))
197.set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
198.set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
199.set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
200.set_account_id_endpoint_mode(::std::option::Option::Some(cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>().cloned().unwrap_or_default().to_string()))
201.set_resource_arn_list(get_resource_arn_list(_input))
202                        .build()
203                        .map_err(|err| ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err))?;
204                    cfg.interceptor_state().store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
205                    ::std::result::Result::Ok(())
206                }
207            }
208
209            // The get_* functions below are generated from JMESPath expressions in the
210            // operationContextParams trait. They target the operation's input shape.
211
212            // Generated from JMESPath Expression: keys(RequestItems)
213fn get_resource_arn_list(input: &crate::operation::batch_get_item::BatchGetItemInput) -> Option<::std::vec::Vec::<::std::string::String>> {
214    let _fld_2 = input.request_items.as_ref()?;
215    let _ret_1 = _fld_2.keys().map(Clone::clone).collect::<Vec<String>>();
216    Some(_ret_1)
217}
218
219/// Error type for the `BatchGetItemError` operation.
220#[non_exhaustive]
221#[derive(::std::fmt::Debug)]
222pub enum BatchGetItemError {
223    /// <p>An error occurred on the server side.</p>
224    InternalServerError(crate::types::error::InternalServerError),
225    #[allow(missing_docs)] // documentation missing in model
226    InvalidEndpointException(crate::types::error::InvalidEndpointException),
227    /// <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>
228    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
229    /// <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>
230    RequestLimitExceeded(crate::types::error::RequestLimitExceeded),
231    /// <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>
232    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
233    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
234                    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
235    variable wildcard pattern and check `.code()`:
236     \
237    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
238     \
239    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-BatchGetItemError) for what information is available for the error.")]
240                    Unhandled(crate::error::sealed_unhandled::Unhandled),
241}
242impl BatchGetItemError {
243    /// Creates the `BatchGetItemError::Unhandled` variant from any error type.
244                    pub fn unhandled(err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>) -> Self {
245                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.into(), meta: ::std::default::Default::default() })
246                    }
247    
248                    /// Creates the `BatchGetItemError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
249                    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
250                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.clone().into(), meta: err })
251                    }
252    /// 
253    /// Returns error metadata, which includes the error code, message,
254    /// request ID, and potentially additional information.
255    /// 
256    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
257        match self {
258            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
259            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
260            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
261            Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
262            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
263            Self::Unhandled(e) => &e.meta,
264        }
265    }
266    /// Returns `true` if the error kind is `BatchGetItemError::InternalServerError`.
267    pub fn is_internal_server_error(&self) -> bool {
268        matches!(self, Self::InternalServerError(_))
269    }
270    /// Returns `true` if the error kind is `BatchGetItemError::InvalidEndpointException`.
271    pub fn is_invalid_endpoint_exception(&self) -> bool {
272        matches!(self, Self::InvalidEndpointException(_))
273    }
274    /// Returns `true` if the error kind is `BatchGetItemError::ProvisionedThroughputExceededException`.
275    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
276        matches!(self, Self::ProvisionedThroughputExceededException(_))
277    }
278    /// Returns `true` if the error kind is `BatchGetItemError::RequestLimitExceeded`.
279    pub fn is_request_limit_exceeded(&self) -> bool {
280        matches!(self, Self::RequestLimitExceeded(_))
281    }
282    /// Returns `true` if the error kind is `BatchGetItemError::ResourceNotFoundException`.
283    pub fn is_resource_not_found_exception(&self) -> bool {
284        matches!(self, Self::ResourceNotFoundException(_))
285    }
286}
287impl ::std::error::Error for BatchGetItemError {
288    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
289        match self {
290            Self::InternalServerError(_inner) =>
291            ::std::option::Option::Some(_inner)
292            ,
293            Self::InvalidEndpointException(_inner) =>
294            ::std::option::Option::Some(_inner)
295            ,
296            Self::ProvisionedThroughputExceededException(_inner) =>
297            ::std::option::Option::Some(_inner)
298            ,
299            Self::RequestLimitExceeded(_inner) =>
300            ::std::option::Option::Some(_inner)
301            ,
302            Self::ResourceNotFoundException(_inner) =>
303            ::std::option::Option::Some(_inner)
304            ,
305            Self::Unhandled(_inner) => {
306                ::std::option::Option::Some(&*_inner.source)
307            }
308        }
309    }
310}
311impl ::std::fmt::Display for BatchGetItemError {
312    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
313        match self {
314            Self::InternalServerError(_inner) =>
315            _inner.fmt(f)
316            ,
317            Self::InvalidEndpointException(_inner) =>
318            _inner.fmt(f)
319            ,
320            Self::ProvisionedThroughputExceededException(_inner) =>
321            _inner.fmt(f)
322            ,
323            Self::RequestLimitExceeded(_inner) =>
324            _inner.fmt(f)
325            ,
326            Self::ResourceNotFoundException(_inner) =>
327            _inner.fmt(f)
328            ,
329            Self::Unhandled(_inner) => {
330                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
331                                                        write!(f, "unhandled error ({code})")
332                                                    } else {
333                                                        f.write_str("unhandled error")
334                                                    }
335            }
336        }
337    }
338}
339impl ::aws_smithy_types::retry::ProvideErrorKind for BatchGetItemError {
340    fn code(&self) -> ::std::option::Option<&str> {
341        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
342    }
343    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
344        ::std::option::Option::None
345    }
346}
347impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for BatchGetItemError {
348    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
349        match self {
350            Self::InternalServerError(_inner) =>
351            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
352            ,
353            Self::InvalidEndpointException(_inner) =>
354            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
355            ,
356            Self::ProvisionedThroughputExceededException(_inner) =>
357            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
358            ,
359            Self::RequestLimitExceeded(_inner) =>
360            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
361            ,
362            Self::ResourceNotFoundException(_inner) =>
363            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
364            ,
365            Self::Unhandled(_inner) => {
366                &_inner.meta
367            }
368        }
369    }
370}
371impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for BatchGetItemError {
372    fn create_unhandled_error(
373                        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
374                        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>
375                    ) -> Self {
376        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source, meta: meta.unwrap_or_default() })
377    }
378}
379impl ::aws_types::request_id::RequestId for crate::operation::batch_get_item::BatchGetItemError {
380                                fn request_id(&self) -> Option<&str> {
381                                    self.meta().request_id()
382                                }
383                            }
384
385pub use crate::operation::batch_get_item::_batch_get_item_output::BatchGetItemOutput;
386
387pub use crate::operation::batch_get_item::_batch_get_item_input::BatchGetItemInput;
388
389mod _batch_get_item_input;
390
391mod _batch_get_item_output;
392
393/// Builders
394pub mod builders;
395