aws_sdk_dynamodb/operation/
list_backups.rs

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

aws_sdk_dynamodb/operation/
list_backups.rs
