aws_sdk_fsx/operation/
delete_backup.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DeleteBackup`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DeleteBackup;
6impl DeleteBackup {
7    /// Creates a new `DeleteBackup`
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::delete_backup::DeleteBackupInput,
14    ) -> ::std::result::Result<
15        crate::operation::delete_backup::DeleteBackupOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::delete_backup::DeleteBackupError,
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::delete_backup::DeleteBackupError>()
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::delete_backup::DeleteBackupOutput>()
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::delete_backup::DeleteBackupInput,
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("FSx", "DeleteBackup", 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                "FSx.DeleteBackup",
59                "rpc.service" = "FSx",
60                "rpc.method" = "DeleteBackup",
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        runtime_plugins = runtime_plugins
74            .with_operation_plugin(crate::client_idempotency_token::IdempotencyTokenRuntimePlugin::new(
75                |token_provider, input| {
76                    let input: &mut crate::operation::delete_backup::DeleteBackupInput = input.downcast_mut().expect("correct type");
77                    if input.client_request_token.is_none() {
78                        input.client_request_token = ::std::option::Option::Some(token_provider.make_idempotency_token());
79                    }
80                },
81            ))
82            .with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
83                ::aws_runtime::auth::sigv4::SCHEME_ID,
84            ]));
85        if let ::std::option::Option::Some(config_override) = config_override {
86            for plugin in config_override.runtime_plugins.iter().cloned() {
87                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
88            }
89            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
90                config_override,
91                client_config.config.clone(),
92                &client_config.runtime_components,
93            ));
94        }
95        runtime_plugins
96    }
97}
98impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DeleteBackup {
99    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
100        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DeleteBackup");
101
102        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
103            DeleteBackupRequestSerializer,
104        ));
105        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
106            DeleteBackupResponseDeserializer,
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
110            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
111        ));
112
113        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DeleteBackup", "FSx"));
114        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
115        signing_options.double_uri_encode = true;
116        signing_options.content_sha256_header = false;
117        signing_options.normalize_uri_path = true;
118        signing_options.payload_override = None;
119
120        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
121            signing_options,
122            ..::std::default::Default::default()
123        });
124
125        ::std::option::Option::Some(cfg.freeze())
126    }
127
128    fn runtime_components(
129        &self,
130        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
131    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
132        #[allow(unused_mut)]
133        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DeleteBackup")
134            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
135            .with_interceptor(DeleteBackupEndpointParamsInterceptor)
136            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
137                crate::operation::delete_backup::DeleteBackupError,
138            >::new())
139            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
140                crate::operation::delete_backup::DeleteBackupError,
141            >::new())
142            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
143                crate::operation::delete_backup::DeleteBackupError,
144            >::new());
145
146        ::std::borrow::Cow::Owned(rcb)
147    }
148}
149
150#[derive(Debug)]
151struct DeleteBackupResponseDeserializer;
152impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteBackupResponseDeserializer {
153    fn deserialize_nonstreaming(
154        &self,
155        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
156    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
157        let (success, status) = (response.status().is_success(), response.status().as_u16());
158        let headers = response.headers();
159        let body = response.body().bytes().expect("body loaded");
160        #[allow(unused_mut)]
161        let mut force_error = false;
162        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
163        let parse_result = if !success && status != 200 || force_error {
164            crate::protocol_serde::shape_delete_backup::de_delete_backup_http_error(status, headers, body)
165        } else {
166            crate::protocol_serde::shape_delete_backup::de_delete_backup_http_response(status, headers, body)
167        };
168        crate::protocol_serde::type_erase_result(parse_result)
169    }
170}
171#[derive(Debug)]
172struct DeleteBackupRequestSerializer;
173impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteBackupRequestSerializer {
174    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
175    fn serialize_input(
176        &self,
177        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
178        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
179    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
180        let input = input
181            .downcast::<crate::operation::delete_backup::DeleteBackupInput>()
182            .expect("correct type");
183        let _header_serialization_settings = _cfg
184            .load::<crate::serialization_settings::HeaderSerializationSettings>()
185            .cloned()
186            .unwrap_or_default();
187        let mut request_builder = {
188            fn uri_base(
189                _input: &crate::operation::delete_backup::DeleteBackupInput,
190                output: &mut ::std::string::String,
191            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
192                use ::std::fmt::Write as _;
193                ::std::write!(output, "/").expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            #[allow(clippy::unnecessary_wraps)]
197            fn update_http_builder(
198                input: &crate::operation::delete_backup::DeleteBackupInput,
199                builder: ::http::request::Builder,
200            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
201                let mut uri = ::std::string::String::new();
202                uri_base(input, &mut uri)?;
203                ::std::result::Result::Ok(builder.method("POST").uri(uri))
204            }
205            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
206            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
207            builder = _header_serialization_settings.set_default_header(
208                builder,
209                ::http::header::HeaderName::from_static("x-amz-target"),
210                "AWSSimbaAPIService_v20180301.DeleteBackup",
211            );
212            builder
213        };
214        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_delete_backup::ser_delete_backup_input(&input)?);
215        if let Some(content_length) = body.content_length() {
216            let content_length = content_length.to_string();
217            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
218        }
219        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
220    }
221}
222#[derive(Debug)]
223struct DeleteBackupEndpointParamsInterceptor;
224
225impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteBackupEndpointParamsInterceptor {
226    fn name(&self) -> &'static str {
227        "DeleteBackupEndpointParamsInterceptor"
228    }
229
230    fn read_before_execution(
231        &self,
232        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
233            '_,
234            ::aws_smithy_runtime_api::client::interceptors::context::Input,
235            ::aws_smithy_runtime_api::client::interceptors::context::Output,
236            ::aws_smithy_runtime_api::client::interceptors::context::Error,
237        >,
238        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
239    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
240        let _input = context
241            .input()
242            .downcast_ref::<DeleteBackupInput>()
243            .ok_or("failed to downcast to DeleteBackupInput")?;
244
245        let params = crate::config::endpoint::Params::builder()
246            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
247            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
248            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
249            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
250            .build()
251            .map_err(|err| {
252                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
253            })?;
254        cfg.interceptor_state()
255            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
256        ::std::result::Result::Ok(())
257    }
258}
259
260// The get_* functions below are generated from JMESPath expressions in the
261// operationContextParams trait. They target the operation's input shape.
262
263/// Error type for the `DeleteBackupError` operation.
264#[non_exhaustive]
265#[derive(::std::fmt::Debug)]
266pub enum DeleteBackupError {
267    /// <p>You can't delete a backup while it's being copied.</p>
268    BackupBeingCopied(crate::types::error::BackupBeingCopied),
269    /// <p>Another backup is already under way. Wait for completion before initiating additional backups of this file system.</p>
270    BackupInProgress(crate::types::error::BackupInProgress),
271    /// <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
272    BackupNotFound(crate::types::error::BackupNotFound),
273    /// <p>You can't delete a backup while it's being used to restore a file system.</p>
274    BackupRestoring(crate::types::error::BackupRestoring),
275    /// <p>A generic error indicating a failure with a client request.</p>
276    BadRequest(crate::types::error::BadRequest),
277    /// <p>The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.</p>
278    IncompatibleParameterError(crate::types::error::IncompatibleParameterError),
279    /// <p>A generic error indicating a server-side failure.</p>
280    InternalServerError(crate::types::error::InternalServerError),
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-DeleteBackupError) for what information is available for the error.")]
288    Unhandled(crate::error::sealed_unhandled::Unhandled),
289}
290impl DeleteBackupError {
291    /// Creates the `DeleteBackupError::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 `DeleteBackupError::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::BackupBeingCopied(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::BackupInProgress(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::BackupNotFound(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::BackupRestoring(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::BadRequest(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::IncompatibleParameterError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::Unhandled(e) => &e.meta,
322        }
323    }
324    /// Returns `true` if the error kind is `DeleteBackupError::BackupBeingCopied`.
325    pub fn is_backup_being_copied(&self) -> bool {
326        matches!(self, Self::BackupBeingCopied(_))
327    }
328    /// Returns `true` if the error kind is `DeleteBackupError::BackupInProgress`.
329    pub fn is_backup_in_progress(&self) -> bool {
330        matches!(self, Self::BackupInProgress(_))
331    }
332    /// Returns `true` if the error kind is `DeleteBackupError::BackupNotFound`.
333    pub fn is_backup_not_found(&self) -> bool {
334        matches!(self, Self::BackupNotFound(_))
335    }
336    /// Returns `true` if the error kind is `DeleteBackupError::BackupRestoring`.
337    pub fn is_backup_restoring(&self) -> bool {
338        matches!(self, Self::BackupRestoring(_))
339    }
340    /// Returns `true` if the error kind is `DeleteBackupError::BadRequest`.
341    pub fn is_bad_request(&self) -> bool {
342        matches!(self, Self::BadRequest(_))
343    }
344    /// Returns `true` if the error kind is `DeleteBackupError::IncompatibleParameterError`.
345    pub fn is_incompatible_parameter_error(&self) -> bool {
346        matches!(self, Self::IncompatibleParameterError(_))
347    }
348    /// Returns `true` if the error kind is `DeleteBackupError::InternalServerError`.
349    pub fn is_internal_server_error(&self) -> bool {
350        matches!(self, Self::InternalServerError(_))
351    }
352}
353impl ::std::error::Error for DeleteBackupError {
354    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
355        match self {
356            Self::BackupBeingCopied(_inner) => ::std::option::Option::Some(_inner),
357            Self::BackupInProgress(_inner) => ::std::option::Option::Some(_inner),
358            Self::BackupNotFound(_inner) => ::std::option::Option::Some(_inner),
359            Self::BackupRestoring(_inner) => ::std::option::Option::Some(_inner),
360            Self::BadRequest(_inner) => ::std::option::Option::Some(_inner),
361            Self::IncompatibleParameterError(_inner) => ::std::option::Option::Some(_inner),
362            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
363            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
364        }
365    }
366}
367impl ::std::fmt::Display for DeleteBackupError {
368    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
369        match self {
370            Self::BackupBeingCopied(_inner) => _inner.fmt(f),
371            Self::BackupInProgress(_inner) => _inner.fmt(f),
372            Self::BackupNotFound(_inner) => _inner.fmt(f),
373            Self::BackupRestoring(_inner) => _inner.fmt(f),
374            Self::BadRequest(_inner) => _inner.fmt(f),
375            Self::IncompatibleParameterError(_inner) => _inner.fmt(f),
376            Self::InternalServerError(_inner) => _inner.fmt(f),
377            Self::Unhandled(_inner) => {
378                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
379                    write!(f, "unhandled error ({code})")
380                } else {
381                    f.write_str("unhandled error")
382                }
383            }
384        }
385    }
386}
387impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteBackupError {
388    fn code(&self) -> ::std::option::Option<&str> {
389        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
390    }
391    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
392        ::std::option::Option::None
393    }
394}
395impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteBackupError {
396    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
397        match self {
398            Self::BackupBeingCopied(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::BackupInProgress(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::BackupNotFound(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::BackupRestoring(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::BadRequest(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::IncompatibleParameterError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::Unhandled(_inner) => &_inner.meta,
406        }
407    }
408}
409impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteBackupError {
410    fn create_unhandled_error(
411        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
412        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
413    ) -> Self {
414        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
415            source,
416            meta: meta.unwrap_or_default(),
417        })
418    }
419}
420impl ::aws_types::request_id::RequestId for crate::operation::delete_backup::DeleteBackupError {
421    fn request_id(&self) -> Option<&str> {
422        self.meta().request_id()
423    }
424}
425
426pub use crate::operation::delete_backup::_delete_backup_output::DeleteBackupOutput;
427
428pub use crate::operation::delete_backup::_delete_backup_input::DeleteBackupInput;
429
430mod _delete_backup_input;
431
432mod _delete_backup_output;
433
434/// Builders
435pub mod builders;