aws_sdk_dynamodb/operation/
query.rs

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

aws_sdk_dynamodb/operation/
query.rs
