aws_sdk_dynamodb/operation/
get_item.rs

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

aws_sdk_dynamodb/operation/
get_item.rs
