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

aws_sdk_backup/operation/
create_legal_hold.rs
