Skip to main content

aws_sdk_backup/operation/
create_legal_hold.rs

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