aws_sdk_dynamodb/operation/
describe_backup.rs

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

aws_sdk_dynamodb/operation/
describe_backup.rs
