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

aws_sdk_dynamodb/operation/
scan.rs
