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

aws_sdk_dynamodb/operation/
describe_backup.rs
