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

aws_sdk_dynamodb/operation/
query.rs
