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>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>
223    ProvisionedThroughputExceededException(crate::types::error::ProvisionedThroughputExceededException),
224    /// <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>
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    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
229                    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
230    variable wildcard pattern and check `.code()`:
231     \
232    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
233     \
234    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-QueryError) for what information is available for the error.")]
235                    Unhandled(crate::error::sealed_unhandled::Unhandled),
236}
237impl QueryError {
238    /// Creates the `QueryError::Unhandled` variant from any error type.
239                    pub fn unhandled(err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>) -> Self {
240                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.into(), meta: ::std::default::Default::default() })
241                    }
242    
243                    /// Creates the `QueryError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
244                    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
245                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.clone().into(), meta: err })
246                    }
247    /// 
248    /// Returns error metadata, which includes the error code, message,
249    /// request ID, and potentially additional information.
250    /// 
251    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
252        match self {
253            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
254            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
255            Self::ProvisionedThroughputExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
256            Self::RequestLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
257            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
258            Self::Unhandled(e) => &e.meta,
259        }
260    }
261    /// Returns `true` if the error kind is `QueryError::InternalServerError`.
262    pub fn is_internal_server_error(&self) -> bool {
263        matches!(self, Self::InternalServerError(_))
264    }
265    /// Returns `true` if the error kind is `QueryError::InvalidEndpointException`.
266    pub fn is_invalid_endpoint_exception(&self) -> bool {
267        matches!(self, Self::InvalidEndpointException(_))
268    }
269    /// Returns `true` if the error kind is `QueryError::ProvisionedThroughputExceededException`.
270    pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool {
271        matches!(self, Self::ProvisionedThroughputExceededException(_))
272    }
273    /// Returns `true` if the error kind is `QueryError::RequestLimitExceeded`.
274    pub fn is_request_limit_exceeded(&self) -> bool {
275        matches!(self, Self::RequestLimitExceeded(_))
276    }
277    /// Returns `true` if the error kind is `QueryError::ResourceNotFoundException`.
278    pub fn is_resource_not_found_exception(&self) -> bool {
279        matches!(self, Self::ResourceNotFoundException(_))
280    }
281}
282impl ::std::error::Error for QueryError {
283    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
284        match self {
285            Self::InternalServerError(_inner) =>
286            ::std::option::Option::Some(_inner)
287            ,
288            Self::InvalidEndpointException(_inner) =>
289            ::std::option::Option::Some(_inner)
290            ,
291            Self::ProvisionedThroughputExceededException(_inner) =>
292            ::std::option::Option::Some(_inner)
293            ,
294            Self::RequestLimitExceeded(_inner) =>
295            ::std::option::Option::Some(_inner)
296            ,
297            Self::ResourceNotFoundException(_inner) =>
298            ::std::option::Option::Some(_inner)
299            ,
300            Self::Unhandled(_inner) => {
301                ::std::option::Option::Some(&*_inner.source)
302            }
303        }
304    }
305}
306impl ::std::fmt::Display for QueryError {
307    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
308        match self {
309            Self::InternalServerError(_inner) =>
310            _inner.fmt(f)
311            ,
312            Self::InvalidEndpointException(_inner) =>
313            _inner.fmt(f)
314            ,
315            Self::ProvisionedThroughputExceededException(_inner) =>
316            _inner.fmt(f)
317            ,
318            Self::RequestLimitExceeded(_inner) =>
319            _inner.fmt(f)
320            ,
321            Self::ResourceNotFoundException(_inner) =>
322            _inner.fmt(f)
323            ,
324            Self::Unhandled(_inner) => {
325                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
326                                                        write!(f, "unhandled error ({code})")
327                                                    } else {
328                                                        f.write_str("unhandled error")
329                                                    }
330            }
331        }
332    }
333}
334impl ::aws_smithy_types::retry::ProvideErrorKind for QueryError {
335    fn code(&self) -> ::std::option::Option<&str> {
336        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
337    }
338    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
339        ::std::option::Option::None
340    }
341}
342impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for QueryError {
343    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
344        match self {
345            Self::InternalServerError(_inner) =>
346            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
347            ,
348            Self::InvalidEndpointException(_inner) =>
349            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
350            ,
351            Self::ProvisionedThroughputExceededException(_inner) =>
352            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
353            ,
354            Self::RequestLimitExceeded(_inner) =>
355            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
356            ,
357            Self::ResourceNotFoundException(_inner) =>
358            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
359            ,
360            Self::Unhandled(_inner) => {
361                &_inner.meta
362            }
363        }
364    }
365}
366impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for QueryError {
367    fn create_unhandled_error(
368                        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
369                        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>
370                    ) -> Self {
371        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source, meta: meta.unwrap_or_default() })
372    }
373}
374impl ::aws_types::request_id::RequestId for crate::operation::query::QueryError {
375                                fn request_id(&self) -> Option<&str> {
376                                    self.meta().request_id()
377                                }
378                            }
379
380pub use crate::operation::query::_query_output::QueryOutput;
381
382pub use crate::operation::query::_query_input::QueryInput;
383
384mod _query_input;
385
386mod _query_output;
387
388/// Builders
389pub mod builders;
390
391/// Paginator for this operation
392pub mod paginator;
393
aws_sdk_dynamodb/operation/query.rs

aws_sdk_dynamodb/operation/
query.rs
