aws_sdk_dynamodb/operation/
scan.rs

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

aws_sdk_dynamodb/operation/
scan.rs
