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

aws_sdk_dynamodb/operation/
batch_get_item.rs
