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<
15        crate::operation::batch_get_item::BatchGetItemOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::batch_get_item::BatchGetItemError,
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::batch_get_item::BatchGetItemError>()
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::batch_get_item::BatchGetItemOutput>()
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::batch_get_item::BatchGetItemInput,
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", "BatchGetItem", 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.BatchGetItem",
59                "rpc.service" = "DynamoDB",
60                "rpc.method" = "BatchGetItem",
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
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for BatchGetItem {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("BatchGetItem");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            BatchGetItemRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            BatchGetItemResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("BatchGetItem")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("BatchGetItem", "DynamoDB"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = true;
108        signing_options.content_sha256_header = false;
109        signing_options.normalize_uri_path = true;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("BatchGetItem")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(BatchGetItemEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::batch_get_item::BatchGetItemError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::batch_get_item::BatchGetItemError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::batch_get_item::BatchGetItemError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct BatchGetItemResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for BatchGetItemResponseDeserializer {
145    fn deserialize_nonstreaming(
146        &self,
147        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
148    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
149        let (success, status) = (response.status().is_success(), response.status().as_u16());
150        let headers = response.headers();
151        let body = response.body().bytes().expect("body loaded");
152        #[allow(unused_mut)]
153        let mut force_error = false;
154        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
155        let parse_result = if !success && status != 200 || force_error {
156            crate::protocol_serde::shape_batch_get_item::de_batch_get_item_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_batch_get_item::de_batch_get_item_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct BatchGetItemRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for BatchGetItemRequestSerializer {
166    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
167    fn serialize_input(
168        &self,
169        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
170        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
171    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
172        let input = input
173            .downcast::<crate::operation::batch_get_item::BatchGetItemInput>()
174            .expect("correct type");
175        let _header_serialization_settings = _cfg
176            .load::<crate::serialization_settings::HeaderSerializationSettings>()
177            .cloned()
178            .unwrap_or_default();
179        let mut request_builder = {
180            fn uri_base(
181                _input: &crate::operation::batch_get_item::BatchGetItemInput,
182                output: &mut ::std::string::String,
183            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
184                use ::std::fmt::Write as _;
185                ::std::write!(output, "/").expect("formatting should succeed");
186                ::std::result::Result::Ok(())
187            }
188            #[allow(clippy::unnecessary_wraps)]
189            fn update_http_builder(
190                input: &crate::operation::batch_get_item::BatchGetItemInput,
191                builder: ::http::request::Builder,
192            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
193                let mut uri = ::std::string::String::new();
194                uri_base(input, &mut uri)?;
195                ::std::result::Result::Ok(builder.method("POST").uri(uri))
196            }
197            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
198            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
199            builder = _header_serialization_settings.set_default_header(
200                builder,
201                ::http::header::HeaderName::from_static("x-amz-target"),
202                "DynamoDB_20120810.BatchGetItem",
203            );
204            builder
205        };
206        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_batch_get_item::ser_batch_get_item_input(&input)?);
207        if let Some(content_length) = body.content_length() {
208            let content_length = content_length.to_string();
209            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
210        }
211        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
212    }
213}
214#[derive(Debug)]
215struct BatchGetItemEndpointParamsInterceptor;
216
217impl ::aws_smithy_runtime_api::client::interceptors::Intercept for BatchGetItemEndpointParamsInterceptor {
218    fn name(&self) -> &'static str {
219        "BatchGetItemEndpointParamsInterceptor"
220    }
221
222    fn read_before_execution(
223        &self,
224        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
225            '_,
226            ::aws_smithy_runtime_api::client::interceptors::context::Input,
227            ::aws_smithy_runtime_api::client::interceptors::context::Output,
228            ::aws_smithy_runtime_api::client::interceptors::context::Error,
229        >,
230        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
231    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
232        let _input = context
233            .input()
234            .downcast_ref::<BatchGetItemInput>()
235            .ok_or("failed to downcast to BatchGetItemInput")?;
236
237        let params = crate::config::endpoint::Params::builder()
238            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
239            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
240            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
241            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
242            .set_account_id_endpoint_mode(::std::option::Option::Some(
243                cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>()
244                    .cloned()
245                    .unwrap_or_default()
246                    .to_string(),
247            ))
248            .set_resource_arn_list(get_resource_arn_list(_input))
249            .build()
250            .map_err(|err| {
251                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
252            })?;
253        cfg.interceptor_state()
254            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
255        ::std::result::Result::Ok(())
256    }
257}
258
259// The get_* functions below are generated from JMESPath expressions in the
260// operationContextParams trait. They target the operation's input shape.
261
262// Generated from JMESPath Expression: keys(RequestItems)
263fn get_resource_arn_list(input: &crate::operation::batch_get_item::BatchGetItemInput) -> Option<::std::vec::Vec<::std::string::String>> {
264    let _fld_2 = input.request_items.as_ref()?;
265    let _ret_1 = _fld_2.keys().map(Clone::clone).collect::<Vec<String>>();
266    Some(_ret_1)
267}
268
269/// Error type for the `BatchGetItemError` operation.
270#[non_exhaustive]
271#[derive(::std::fmt::Debug)]
272pub enum BatchGetItemError {
273    /// <p>An error occurred on the server side.</p>
274    InternalServerError(crate::types::error::InternalServerError),
275    #[allow(missing_docs)] // documentation missing in model
276    InvalidEndpointException(crate::types::error::InvalidEndpointException),
277    /// <p>The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. 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>
278    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
279    /// <p>Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. Contact <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a quota increase.</p>
280    RequestLimitExceeded(crate::types::error::RequestLimitExceeded),
281    /// <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>
282    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
283    /// <p>The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception.</p>
284    ThrottlingException(crate::types::error::ThrottlingException),
285    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
286    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
287    variable wildcard pattern and check `.code()`:
288     \
289    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
290     \
291    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-BatchGetItemError) for what information is available for the error.")]
292    Unhandled(crate::error::sealed_unhandled::Unhandled),
293}
294impl BatchGetItemError {
295    /// Creates the `BatchGetItemError::Unhandled` variant from any error type.
296    pub fn unhandled(
297        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
298    ) -> Self {
299        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
300            source: err.into(),
301            meta: ::std::default::Default::default(),
302        })
303    }
304
305    /// Creates the `BatchGetItemError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
306    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
307        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
308            source: err.clone().into(),
309            meta: err,
310        })
311    }
312    ///
313    /// Returns error metadata, which includes the error code, message,
314    /// request ID, and potentially additional information.
315    ///
316    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
317        match self {
318            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::Unhandled(e) => &e.meta,
325        }
326    }
327    /// Returns `true` if the error kind is `BatchGetItemError::InternalServerError`.
328    pub fn is_internal_server_error(&self) -> bool {
329        matches!(self, Self::InternalServerError(_))
330    }
331    /// Returns `true` if the error kind is `BatchGetItemError::InvalidEndpointException`.
332    pub fn is_invalid_endpoint_exception(&self) -> bool {
333        matches!(self, Self::InvalidEndpointException(_))
334    }
335    /// Returns `true` if the error kind is `BatchGetItemError::ProvisionedThroughputExceededException`.
336    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
337        matches!(self, Self::ProvisionedThroughputExceededException(_))
338    }
339    /// Returns `true` if the error kind is `BatchGetItemError::RequestLimitExceeded`.
340    pub fn is_request_limit_exceeded(&self) -> bool {
341        matches!(self, Self::RequestLimitExceeded(_))
342    }
343    /// Returns `true` if the error kind is `BatchGetItemError::ResourceNotFoundException`.
344    pub fn is_resource_not_found_exception(&self) -> bool {
345        matches!(self, Self::ResourceNotFoundException(_))
346    }
347    /// Returns `true` if the error kind is `BatchGetItemError::ThrottlingException`.
348    pub fn is_throttling_exception(&self) -> bool {
349        matches!(self, Self::ThrottlingException(_))
350    }
351}
352impl ::std::error::Error for BatchGetItemError {
353    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
354        match self {
355            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
356            Self::InvalidEndpointException(_inner) => ::std::option::Option::Some(_inner),
357            Self::ProvisionedThroughputExceededException(_inner) => ::std::option::Option::Some(_inner),
358            Self::RequestLimitExceeded(_inner) => ::std::option::Option::Some(_inner),
359            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
360            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
361            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
362        }
363    }
364}
365impl ::std::fmt::Display for BatchGetItemError {
366    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
367        match self {
368            Self::InternalServerError(_inner) => _inner.fmt(f),
369            Self::InvalidEndpointException(_inner) => _inner.fmt(f),
370            Self::ProvisionedThroughputExceededException(_inner) => _inner.fmt(f),
371            Self::RequestLimitExceeded(_inner) => _inner.fmt(f),
372            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
373            Self::ThrottlingException(_inner) => _inner.fmt(f),
374            Self::Unhandled(_inner) => {
375                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
376                    write!(f, "unhandled error ({code})")
377                } else {
378                    f.write_str("unhandled error")
379                }
380            }
381        }
382    }
383}
384impl ::aws_smithy_types::retry::ProvideErrorKind for BatchGetItemError {
385    fn code(&self) -> ::std::option::Option<&str> {
386        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
387    }
388    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
389        ::std::option::Option::None
390    }
391}
392impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for BatchGetItemError {
393    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
394        match self {
395            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::InvalidEndpointException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::ProvisionedThroughputExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::RequestLimitExceeded(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::Unhandled(_inner) => &_inner.meta,
402        }
403    }
404}
405impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for BatchGetItemError {
406    fn create_unhandled_error(
407        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
408        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
409    ) -> Self {
410        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
411            source,
412            meta: meta.unwrap_or_default(),
413        })
414    }
415}
416impl ::aws_types::request_id::RequestId for crate::operation::batch_get_item::BatchGetItemError {
417    fn request_id(&self) -> Option<&str> {
418        self.meta().request_id()
419    }
420}
421
422pub use crate::operation::batch_get_item::_batch_get_item_output::BatchGetItemOutput;
423
424pub use crate::operation::batch_get_item::_batch_get_item_input::BatchGetItemInput;
425
426mod _batch_get_item_input;
427
428mod _batch_get_item_output;
429
430/// Builders
431pub mod builders;
aws_sdk_dynamodb/operation/batch_get_item.rs

aws_sdk_dynamodb/operation/
batch_get_item.rs
