aws_sdk_backup/operation/
cancel_legal_hold.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `CancelLegalHold`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CancelLegalHold;
6impl CancelLegalHold {
7    /// Creates a new `CancelLegalHold`
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::cancel_legal_hold::CancelLegalHoldInput,
14    ) -> ::std::result::Result<
15        crate::operation::cancel_legal_hold::CancelLegalHoldOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::cancel_legal_hold::CancelLegalHoldError,
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::cancel_legal_hold::CancelLegalHoldError>()
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::cancel_legal_hold::CancelLegalHoldOutput>()
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::cancel_legal_hold::CancelLegalHoldInput,
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("Backup", "CancelLegalHold", 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                "Backup.CancelLegalHold",
59                "rpc.service" = "Backup",
60                "rpc.method" = "CancelLegalHold",
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 CancelLegalHold {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CancelLegalHold");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            CancelLegalHoldRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            CancelLegalHoldResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("CancelLegalHold")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("CancelLegalHold", "Backup"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = true;
108        signing_options.content_sha256_header = false;
109        signing_options.normalize_uri_path = true;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("CancelLegalHold")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                CancelLegalHoldEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::cancel_legal_hold::CancelLegalHoldError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::cancel_legal_hold::CancelLegalHoldError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::cancel_legal_hold::CancelLegalHoldError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct CancelLegalHoldResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CancelLegalHoldResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 201 || force_error {
160            crate::protocol_serde::shape_cancel_legal_hold::de_cancel_legal_hold_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_cancel_legal_hold::de_cancel_legal_hold_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct CancelLegalHoldRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CancelLegalHoldRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::cancel_legal_hold::CancelLegalHoldInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            #[allow(clippy::uninlined_format_args)]
185            fn uri_base(
186                _input: &crate::operation::cancel_legal_hold::CancelLegalHoldInput,
187                output: &mut ::std::string::String,
188            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
189                use ::std::fmt::Write as _;
190                let input_1 = &_input.legal_hold_id;
191                let input_1 = input_1
192                    .as_ref()
193                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("legal_hold_id", "cannot be empty or unset"))?;
194                let legal_hold_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
195                if legal_hold_id.is_empty() {
196                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
197                        "legal_hold_id",
198                        "cannot be empty or unset",
199                    ));
200                }
201                ::std::write!(output, "/legal-holds/{LegalHoldId}", LegalHoldId = legal_hold_id).expect("formatting should succeed");
202                ::std::result::Result::Ok(())
203            }
204            fn uri_query(
205                _input: &crate::operation::cancel_legal_hold::CancelLegalHoldInput,
206                mut output: &mut ::std::string::String,
207            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
208                let mut query = ::aws_smithy_http::query::Writer::new(output);
209                let inner_2 = &_input.cancel_description;
210                let inner_2 = inner_2.as_ref().ok_or_else(|| {
211                    ::aws_smithy_types::error::operation::BuildError::missing_field("cancel_description", "cannot be empty or unset")
212                })?;
213                if inner_2.is_empty() {
214                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
215                        "cancel_description",
216                        "cannot be empty or unset",
217                    ));
218                }
219                query.push_kv("cancelDescription", &::aws_smithy_http::query::fmt_string(inner_2));
220                if let ::std::option::Option::Some(inner_3) = &_input.retain_record_in_days {
221                    {
222                        query.push_kv("retainRecordInDays", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
223                    }
224                }
225                ::std::result::Result::Ok(())
226            }
227            #[allow(clippy::unnecessary_wraps)]
228            fn update_http_builder(
229                input: &crate::operation::cancel_legal_hold::CancelLegalHoldInput,
230                builder: ::http_1x::request::Builder,
231            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
232                let mut uri = ::std::string::String::new();
233                uri_base(input, &mut uri)?;
234                uri_query(input, &mut uri)?;
235                ::std::result::Result::Ok(builder.method("DELETE").uri(uri))
236            }
237            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
238            builder
239        };
240        let body = ::aws_smithy_types::body::SdkBody::from("");
241
242        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
243    }
244}
245#[derive(Debug)]
246struct CancelLegalHoldEndpointParamsInterceptor;
247
248#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
249impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CancelLegalHoldEndpointParamsInterceptor {
250    fn name(&self) -> &'static str {
251        "CancelLegalHoldEndpointParamsInterceptor"
252    }
253
254    fn read_before_execution(
255        &self,
256        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
257            '_,
258            ::aws_smithy_runtime_api::client::interceptors::context::Input,
259            ::aws_smithy_runtime_api::client::interceptors::context::Output,
260            ::aws_smithy_runtime_api::client::interceptors::context::Error,
261        >,
262        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
263    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
264        let _input = context
265            .input()
266            .downcast_ref::<CancelLegalHoldInput>()
267            .ok_or("failed to downcast to CancelLegalHoldInput")?;
268
269        let params = crate::config::endpoint::Params::builder()
270            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
271            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
272            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
273            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
274            .build()
275            .map_err(|err| {
276                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
277            })?;
278        cfg.interceptor_state()
279            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
280        ::std::result::Result::Ok(())
281    }
282}
283
284// The get_* functions below are generated from JMESPath expressions in the
285// operationContextParams trait. They target the operation's input shape.
286
287/// Error type for the `CancelLegalHoldError` operation.
288#[non_exhaustive]
289#[derive(::std::fmt::Debug)]
290pub enum CancelLegalHoldError {
291    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
292    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
293    /// <p>Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.</p>
294    InvalidResourceStateException(crate::types::error::InvalidResourceStateException),
295    /// <p>Indicates that a required parameter is missing.</p>
296    MissingParameterValueException(crate::types::error::MissingParameterValueException),
297    /// <p>A resource that is required for the action doesn't exist.</p>
298    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
299    /// <p>The request failed due to a temporary failure of the server.</p>
300    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
301    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
302    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
303    variable wildcard pattern and check `.code()`:
304     \
305    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
306     \
307    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CancelLegalHoldError) for what information is available for the error.")]
308    Unhandled(crate::error::sealed_unhandled::Unhandled),
309}
310impl CancelLegalHoldError {
311    /// Creates the `CancelLegalHoldError::Unhandled` variant from any error type.
312    pub fn unhandled(
313        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
314    ) -> Self {
315        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
316            source: err.into(),
317            meta: ::std::default::Default::default(),
318        })
319    }
320
321    /// Creates the `CancelLegalHoldError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
322    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
323        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
324            source: err.clone().into(),
325            meta: err,
326        })
327    }
328    ///
329    /// Returns error metadata, which includes the error code, message,
330    /// request ID, and potentially additional information.
331    ///
332    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
333        match self {
334            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::InvalidResourceStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::Unhandled(e) => &e.meta,
340        }
341    }
342    /// Returns `true` if the error kind is `CancelLegalHoldError::InvalidParameterValueException`.
343    pub fn is_invalid_parameter_value_exception(&self) -> bool {
344        matches!(self, Self::InvalidParameterValueException(_))
345    }
346    /// Returns `true` if the error kind is `CancelLegalHoldError::InvalidResourceStateException`.
347    pub fn is_invalid_resource_state_exception(&self) -> bool {
348        matches!(self, Self::InvalidResourceStateException(_))
349    }
350    /// Returns `true` if the error kind is `CancelLegalHoldError::MissingParameterValueException`.
351    pub fn is_missing_parameter_value_exception(&self) -> bool {
352        matches!(self, Self::MissingParameterValueException(_))
353    }
354    /// Returns `true` if the error kind is `CancelLegalHoldError::ResourceNotFoundException`.
355    pub fn is_resource_not_found_exception(&self) -> bool {
356        matches!(self, Self::ResourceNotFoundException(_))
357    }
358    /// Returns `true` if the error kind is `CancelLegalHoldError::ServiceUnavailableException`.
359    pub fn is_service_unavailable_exception(&self) -> bool {
360        matches!(self, Self::ServiceUnavailableException(_))
361    }
362}
363impl ::std::error::Error for CancelLegalHoldError {
364    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
365        match self {
366            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InvalidResourceStateException(_inner) => ::std::option::Option::Some(_inner),
368            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
369            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
370            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
371            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
372        }
373    }
374}
375impl ::std::fmt::Display for CancelLegalHoldError {
376    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
377        match self {
378            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
379            Self::InvalidResourceStateException(_inner) => _inner.fmt(f),
380            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
381            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
382            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
383            Self::Unhandled(_inner) => {
384                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
385                    write!(f, "unhandled error ({code})")
386                } else {
387                    f.write_str("unhandled error")
388                }
389            }
390        }
391    }
392}
393impl ::aws_smithy_types::retry::ProvideErrorKind for CancelLegalHoldError {
394    fn code(&self) -> ::std::option::Option<&str> {
395        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
396    }
397    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
398        ::std::option::Option::None
399    }
400}
401impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CancelLegalHoldError {
402    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
403        match self {
404            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::InvalidResourceStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::Unhandled(_inner) => &_inner.meta,
410        }
411    }
412}
413impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CancelLegalHoldError {
414    fn create_unhandled_error(
415        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
416        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
417    ) -> Self {
418        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
419            source,
420            meta: meta.unwrap_or_default(),
421        })
422    }
423}
424impl ::aws_types::request_id::RequestId for crate::operation::cancel_legal_hold::CancelLegalHoldError {
425    fn request_id(&self) -> Option<&str> {
426        self.meta().request_id()
427    }
428}
429
430pub use crate::operation::cancel_legal_hold::_cancel_legal_hold_input::CancelLegalHoldInput;
431
432pub use crate::operation::cancel_legal_hold::_cancel_legal_hold_output::CancelLegalHoldOutput;
433
434mod _cancel_legal_hold_input;
435
436mod _cancel_legal_hold_output;
437
438/// Builders
439pub mod builders;
aws_sdk_backup/operation/cancel_legal_hold.rs

aws_sdk_backup/operation/
cancel_legal_hold.rs
