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<crate::operation::get_item::GetItemOutput, ::aws_smithy_runtime_api::client::result::SdkError<crate::operation::get_item::GetItemError, ::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::get_item::GetItemError>().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::get_item::GetItemOutput>().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::get_item::GetItemInput,
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                            "GetItem",
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.GetItem",
45                                "rpc.service" = "DynamoDB",
46                                "rpc.method" = "GetItem",
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 GetItem {
72                fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
73                    let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetItem");
74
75                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(GetItemRequestSerializer));
76                    cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(GetItemResponseDeserializer));
77
78                    cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
79                        crate::config::auth::Params::builder()
80                            .operation_name("GetItem")
81                            .build()
82                            .expect("required fields set")
83                    ));
84
85                    cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
86                            "GetItem",
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("GetItem")
106                            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
107.with_interceptor(GetItemEndpointParamsInterceptor)
108                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::get_item::GetItemError>::new())
109.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::get_item::GetItemError>::new())
110.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::get_item::GetItemError>::new());
111
112                    ::std::borrow::Cow::Owned(rcb)
113                }
114            }
115
116            
117#[derive(Debug)]
118            struct GetItemResponseDeserializer;
119            impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetItemResponseDeserializer {
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_get_item::de_get_item_http_error(status, headers, body)
131            } else {
132                crate::protocol_serde::shape_get_item::de_get_item_http_response(status, headers, body)
133            };
134            crate::protocol_serde::type_erase_result(parse_result)
135                }
136            }
137#[derive(Debug)]
138            struct GetItemRequestSerializer;
139            impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetItemRequestSerializer {
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::get_item::GetItemInput>().expect("correct type");
143                    let _header_serialization_settings = _cfg.load::<crate::serialization_settings::HeaderSerializationSettings>().cloned().unwrap_or_default();
144                    let mut request_builder = {
145                        #[allow(clippy::uninlined_format_args)]
146fn uri_base(_input: &crate::operation::get_item::GetItemInput, output: &mut ::std::string::String) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
147    use ::std::fmt::Write as _;
148    ::std::write!(output, "/").expect("formatting should succeed");
149    ::std::result::Result::Ok(())
150}
151#[allow(clippy::unnecessary_wraps)]
152fn update_http_builder(
153                input: &crate::operation::get_item::GetItemInput,
154                builder: ::http::request::Builder
155            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
156    let mut uri = ::std::string::String::new();
157    uri_base(input, &mut uri)?;
158    ::std::result::Result::Ok(builder.method("POST").uri(uri))
159}
160let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
161builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
162builder = _header_serialization_settings.set_default_header(
163                        builder,
164                        ::http::header::HeaderName::from_static("x-amz-target"),
165                        "DynamoDB_20120810.GetItem"
166                    );
167builder
168                    };
169                    let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_item::ser_get_item_input(&input)?);
170                    if let Some(content_length) = body.content_length() {
171                                let content_length = content_length.to_string();
172                                request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
173                            }
174                    ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
175                }
176            }
177#[derive(Debug)]
178            struct GetItemEndpointParamsInterceptor;
179
180            impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetItemEndpointParamsInterceptor {
181                fn name(&self) -> &'static str {
182                    "GetItemEndpointParamsInterceptor"
183                }
184
185                fn read_before_execution(
186                    &self,
187                    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>,
188                    cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
189                ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
190                    let _input = context.input()
191                        .downcast_ref::<GetItemInput>()
192                        .ok_or("failed to downcast to GetItemInput")?;
193
194                    
195
196                    let params = crate::config::endpoint::Params::builder()
197                        .set_region(cfg.load::<::aws_types::region::Region>().map(|r|r.as_ref().to_owned()))
198.set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
199.set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
200.set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
201.set_account_id_endpoint_mode(::std::option::Option::Some(cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>().cloned().unwrap_or_default().to_string()))
202.set_resource_arn(Some(_input.table_name.clone().filter(|f|!AsRef::<str>::as_ref(f).trim().is_empty()).ok_or_else(||::aws_smithy_types::error::operation::BuildError::missing_field("table_name", "A required field was not set"))?))
203                        .build()
204                        .map_err(|err| ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err))?;
205                    cfg.interceptor_state().store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
206                    ::std::result::Result::Ok(())
207                }
208            }
209
210            // The get_* functions below are generated from JMESPath expressions in the
211            // operationContextParams trait. They target the operation's input shape.
212
213            
214
215/// Error type for the `GetItemError` operation.
216#[non_exhaustive]
217#[derive(::std::fmt::Debug)]
218pub enum GetItemError {
219    /// <p>An error occurred on the server side.</p>
220    InternalServerError(crate::types::error::InternalServerError),
221    #[allow(missing_docs)] // documentation missing in model
222    InvalidEndpointException(crate::types::error::InvalidEndpointException),
223    /// <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>
224    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
225    /// <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>
226    RequestLimitExceeded(crate::types::error::RequestLimitExceeded),
227    /// <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>
228    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
229    /// <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>
230    ThrottlingException(crate::types::error::ThrottlingException),
231    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
232                    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
233    variable wildcard pattern and check `.code()`:
234     \
235    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
236     \
237    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetItemError) for what information is available for the error.")]
238                    Unhandled(crate::error::sealed_unhandled::Unhandled),
239}
240impl GetItemError {
241    /// Creates the `GetItemError::Unhandled` variant from any error type.
242                    pub fn unhandled(err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>) -> Self {
243                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.into(), meta: ::std::default::Default::default() })
244                    }
245    
246                    /// Creates the `GetItemError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
247                    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
248                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.clone().into(), meta: err })
249                    }
250    /// 
251    /// Returns error metadata, which includes the error code, message,
252    /// request ID, and potentially additional information.
253    /// 
254    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
255        match self {
256            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
257            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
258            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
259            Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
260            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
261            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
262            Self::Unhandled(e) => &e.meta,
263        }
264    }
265    /// Returns `true` if the error kind is `GetItemError::InternalServerError`.
266    pub fn is_internal_server_error(&self) -> bool {
267        matches!(self, Self::InternalServerError(_))
268    }
269    /// Returns `true` if the error kind is `GetItemError::InvalidEndpointException`.
270    pub fn is_invalid_endpoint_exception(&self) -> bool {
271        matches!(self, Self::InvalidEndpointException(_))
272    }
273    /// Returns `true` if the error kind is `GetItemError::ProvisionedThroughputExceededException`.
274    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
275        matches!(self, Self::ProvisionedThroughputExceededException(_))
276    }
277    /// Returns `true` if the error kind is `GetItemError::RequestLimitExceeded`.
278    pub fn is_request_limit_exceeded(&self) -> bool {
279        matches!(self, Self::RequestLimitExceeded(_))
280    }
281    /// Returns `true` if the error kind is `GetItemError::ResourceNotFoundException`.
282    pub fn is_resource_not_found_exception(&self) -> bool {
283        matches!(self, Self::ResourceNotFoundException(_))
284    }
285    /// Returns `true` if the error kind is `GetItemError::ThrottlingException`.
286    pub fn is_throttling_exception(&self) -> bool {
287        matches!(self, Self::ThrottlingException(_))
288    }
289}
290impl ::std::error::Error for GetItemError {
291    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
292        match self {
293            Self::InternalServerError(_inner) =>
294            ::std::option::Option::Some(_inner)
295            ,
296            Self::InvalidEndpointException(_inner) =>
297            ::std::option::Option::Some(_inner)
298            ,
299            Self::ProvisionedThroughputExceededException(_inner) =>
300            ::std::option::Option::Some(_inner)
301            ,
302            Self::RequestLimitExceeded(_inner) =>
303            ::std::option::Option::Some(_inner)
304            ,
305            Self::ResourceNotFoundException(_inner) =>
306            ::std::option::Option::Some(_inner)
307            ,
308            Self::ThrottlingException(_inner) =>
309            ::std::option::Option::Some(_inner)
310            ,
311            Self::Unhandled(_inner) => {
312                ::std::option::Option::Some(&*_inner.source)
313            }
314        }
315    }
316}
317impl ::std::fmt::Display for GetItemError {
318    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
319        match self {
320            Self::InternalServerError(_inner) =>
321            _inner.fmt(f)
322            ,
323            Self::InvalidEndpointException(_inner) =>
324            _inner.fmt(f)
325            ,
326            Self::ProvisionedThroughputExceededException(_inner) =>
327            _inner.fmt(f)
328            ,
329            Self::RequestLimitExceeded(_inner) =>
330            _inner.fmt(f)
331            ,
332            Self::ResourceNotFoundException(_inner) =>
333            _inner.fmt(f)
334            ,
335            Self::ThrottlingException(_inner) =>
336            _inner.fmt(f)
337            ,
338            Self::Unhandled(_inner) => {
339                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
340                                                        write!(f, "unhandled error ({code})")
341                                                    } else {
342                                                        f.write_str("unhandled error")
343                                                    }
344            }
345        }
346    }
347}
348impl ::aws_smithy_types::retry::ProvideErrorKind for GetItemError {
349    fn code(&self) -> ::std::option::Option<&str> {
350        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
351    }
352    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
353        ::std::option::Option::None
354    }
355}
356impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetItemError {
357    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
358        match self {
359            Self::InternalServerError(_inner) =>
360            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
361            ,
362            Self::InvalidEndpointException(_inner) =>
363            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
364            ,
365            Self::ProvisionedThroughputExceededException(_inner) =>
366            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
367            ,
368            Self::RequestLimitExceeded(_inner) =>
369            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
370            ,
371            Self::ResourceNotFoundException(_inner) =>
372            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
373            ,
374            Self::ThrottlingException(_inner) =>
375            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
376            ,
377            Self::Unhandled(_inner) => {
378                &_inner.meta
379            }
380        }
381    }
382}
383impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetItemError {
384    fn create_unhandled_error(
385                        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
386                        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>
387                    ) -> Self {
388        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source, meta: meta.unwrap_or_default() })
389    }
390}
391impl ::aws_types::request_id::RequestId for crate::operation::get_item::GetItemError {
392                                fn request_id(&self) -> Option<&str> {
393                                    self.meta().request_id()
394                                }
395                            }
396
397pub use crate::operation::get_item::_get_item_output::GetItemOutput;
398
399pub use crate::operation::get_item::_get_item_input::GetItemInput;
400
401mod _get_item_input;
402
403mod _get_item_output;
404
405/// Builders
406pub mod builders;
407
aws_sdk_dynamodb/operation/get_item.rs

aws_sdk_dynamodb/operation/
get_item.rs
