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

aws_sdk_dynamodb/operation/
scan.rs
