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<
15        crate::operation::describe_backup::DescribeBackupOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_backup::DescribeBackupError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::describe_backup::DescribeBackupError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::describe_backup::DescribeBackupOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::describe_backup::DescribeBackupInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("DynamoDB", "DescribeBackup", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "DynamoDB.DescribeBackup",
59                "rpc.service" = "DynamoDB",
60                "rpc.method" = "DescribeBackup",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeBackup {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeBackup");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeBackupRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeBackupResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeBackup")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeBackup",
107            "DynamoDB",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeBackup")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(DescribeBackupEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::describe_backup::DescribeBackupError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::describe_backup::DescribeBackupError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::describe_backup::DescribeBackupError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct DescribeBackupResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeBackupResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_describe_backup::de_describe_backup_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_describe_backup::de_describe_backup_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct DescribeBackupRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeBackupRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::describe_backup::DescribeBackupInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::describe_backup::DescribeBackupInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::describe_backup::DescribeBackupInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("POST").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
202            builder = _header_serialization_settings.set_default_header(
203                builder,
204                ::http::header::HeaderName::from_static("x-amz-target"),
205                "DynamoDB_20120810.DescribeBackup",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_backup::ser_describe_backup_input(&input)?);
210        if let Some(content_length) = body.content_length() {
211            let content_length = content_length.to_string();
212            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
213        }
214        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
215    }
216}
217#[derive(Debug)]
218struct DescribeBackupEndpointParamsInterceptor;
219
220impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeBackupEndpointParamsInterceptor {
221    fn name(&self) -> &'static str {
222        "DescribeBackupEndpointParamsInterceptor"
223    }
224
225    fn read_before_execution(
226        &self,
227        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
228            '_,
229            ::aws_smithy_runtime_api::client::interceptors::context::Input,
230            ::aws_smithy_runtime_api::client::interceptors::context::Output,
231            ::aws_smithy_runtime_api::client::interceptors::context::Error,
232        >,
233        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
234    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
235        let _input = context
236            .input()
237            .downcast_ref::<DescribeBackupInput>()
238            .ok_or("failed to downcast to DescribeBackupInput")?;
239
240        let params = crate::config::endpoint::Params::builder()
241            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
242            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
243            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
244            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
245            .set_account_id_endpoint_mode(::std::option::Option::Some(
246                cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>()
247                    .cloned()
248                    .unwrap_or_default()
249                    .to_string(),
250            ))
251            .set_resource_arn(Some(
252                _input
253                    .backup_arn
254                    .clone()
255                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
256                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("backup_arn", "A required field was not set"))?,
257            ))
258            .build()
259            .map_err(|err| {
260                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
261            })?;
262        cfg.interceptor_state()
263            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
264        ::std::result::Result::Ok(())
265    }
266}
267
268// The get_* functions below are generated from JMESPath expressions in the
269// operationContextParams trait. They target the operation's input shape.
270
271/// Error type for the `DescribeBackupError` operation.
272#[non_exhaustive]
273#[derive(::std::fmt::Debug)]
274pub enum DescribeBackupError {
275    /// <p>Backup not found for the given BackupARN.</p>
276    BackupNotFoundException(crate::types::error::BackupNotFoundException),
277    /// <p>An error occurred on the server side.</p>
278    InternalServerError(crate::types::error::InternalServerError),
279    #[allow(missing_docs)] // documentation missing in model
280    InvalidEndpointException(crate::types::error::InvalidEndpointException),
281    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
282    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
283    variable wildcard pattern and check `.code()`:
284     \
285    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
286     \
287    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeBackupError) for what information is available for the error.")]
288    Unhandled(crate::error::sealed_unhandled::Unhandled),
289}
290impl DescribeBackupError {
291    /// Creates the `DescribeBackupError::Unhandled` variant from any error type.
292    pub fn unhandled(
293        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
294    ) -> Self {
295        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
296            source: err.into(),
297            meta: ::std::default::Default::default(),
298        })
299    }
300
301    /// Creates the `DescribeBackupError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
302    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
303        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
304            source: err.clone().into(),
305            meta: err,
306        })
307    }
308    ///
309    /// Returns error metadata, which includes the error code, message,
310    /// request ID, and potentially additional information.
311    ///
312    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
313        match self {
314            Self::BackupNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::Unhandled(e) => &e.meta,
318        }
319    }
320    /// Returns `true` if the error kind is `DescribeBackupError::BackupNotFoundException`.
321    pub fn is_backup_not_found_exception(&self) -> bool {
322        matches!(self, Self::BackupNotFoundException(_))
323    }
324    /// Returns `true` if the error kind is `DescribeBackupError::InternalServerError`.
325    pub fn is_internal_server_error(&self) -> bool {
326        matches!(self, Self::InternalServerError(_))
327    }
328    /// Returns `true` if the error kind is `DescribeBackupError::InvalidEndpointException`.
329    pub fn is_invalid_endpoint_exception(&self) -> bool {
330        matches!(self, Self::InvalidEndpointException(_))
331    }
332}
333impl ::std::error::Error for DescribeBackupError {
334    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
335        match self {
336            Self::BackupNotFoundException(_inner) => ::std::option::Option::Some(_inner),
337            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
338            Self::InvalidEndpointException(_inner) => ::std::option::Option::Some(_inner),
339            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
340        }
341    }
342}
343impl ::std::fmt::Display for DescribeBackupError {
344    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
345        match self {
346            Self::BackupNotFoundException(_inner) => _inner.fmt(f),
347            Self::InternalServerError(_inner) => _inner.fmt(f),
348            Self::InvalidEndpointException(_inner) => _inner.fmt(f),
349            Self::Unhandled(_inner) => {
350                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
351                    write!(f, "unhandled error ({code})")
352                } else {
353                    f.write_str("unhandled error")
354                }
355            }
356        }
357    }
358}
359impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeBackupError {
360    fn code(&self) -> ::std::option::Option<&str> {
361        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
362    }
363    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
364        ::std::option::Option::None
365    }
366}
367impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeBackupError {
368    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
369        match self {
370            Self::BackupNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
371            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::InvalidEndpointException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::Unhandled(_inner) => &_inner.meta,
374        }
375    }
376}
377impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeBackupError {
378    fn create_unhandled_error(
379        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
380        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
381    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
383            source,
384            meta: meta.unwrap_or_default(),
385        })
386    }
387}
388impl ::aws_types::request_id::RequestId for crate::operation::describe_backup::DescribeBackupError {
389    fn request_id(&self) -> Option<&str> {
390        self.meta().request_id()
391    }
392}
393
394pub use crate::operation::describe_backup::_describe_backup_output::DescribeBackupOutput;
395
396pub use crate::operation::describe_backup::_describe_backup_input::DescribeBackupInput;
397
398mod _describe_backup_input;
399
400mod _describe_backup_output;
401
402/// Builders
403pub mod builders;
aws_sdk_dynamodb/operation/describe_backup.rs

aws_sdk_dynamodb/operation/
describe_backup.rs
