aws_sdk_s3/operation/
restore_object.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `RestoreObject`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct RestoreObject;
6impl RestoreObject {
7    /// Creates a new `RestoreObject`
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::restore_object::RestoreObjectInput,
14    ) -> ::std::result::Result<
15        crate::operation::restore_object::RestoreObjectOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::restore_object::RestoreObjectError,
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::restore_object::RestoreObjectError>()
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::restore_object::RestoreObjectOutput>()
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::restore_object::RestoreObjectInput,
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("S3", "RestoreObject", 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                "S3.RestoreObject",
59                "rpc.service" = "S3",
60                "rpc.method" = "RestoreObject",
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 RestoreObject {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("RestoreObject");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            RestoreObjectRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            RestoreObjectResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("RestoreObject")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("RestoreObject", "S3"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = false;
108        signing_options.content_sha256_header = true;
109        signing_options.normalize_uri_path = false;
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("RestoreObject")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(RestoreObjectEndpointParamsInterceptor)
128            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
129                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
130                    let input: &crate::operation::restore_object::RestoreObjectInput = input.downcast_ref().expect("correct type");
131                    let checksum_algorithm = input.checksum_algorithm();
132                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
133                    (checksum_algorithm.map(|s| s.to_string()), false)
134                },
135                |request: &mut ::aws_smithy_runtime_api::http::Request, cfg: &::aws_smithy_types::config_bag::ConfigBag| {
136                    // We check if the user has set any of the checksum values manually
137                    let mut user_set_checksum_value = false;
138                    let headers_to_check =
139                        request
140                            .headers()
141                            .iter()
142                            .filter_map(|(name, _val)| if name.starts_with("x-amz-checksum-") { Some(name) } else { None });
143                    for algo_header in headers_to_check {
144                        if request.headers().get(algo_header).is_some() {
145                            user_set_checksum_value = true;
146                        }
147                    }
148
149                    // We check if the user set the checksum algo manually
150                    let user_set_checksum_algo = request.headers().get("x-amz-sdk-checksum-algorithm").is_some();
151
152                    // This value is set by the user on the SdkConfig to indicate their preference
153                    let request_checksum_calculation = cfg
154                        .load::<::aws_smithy_types::checksum_config::RequestChecksumCalculation>()
155                        .unwrap_or(&::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported);
156
157                    // From the httpChecksum trait
158                    let http_checksum_required = false;
159
160                    let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
161
162                    // If the request is presigned we do not set a default.
163                    // If the RequestChecksumCalculation is WhenSupported and the user has not set a checksum value or algo
164                    // we set the default. If it is WhenRequired and a checksum is required by the trait and the user has not
165                    // set a checksum value or algo we also set the default. In all other cases we do nothing.
166                    match (
167                        request_checksum_calculation,
168                        http_checksum_required,
169                        user_set_checksum_value,
170                        user_set_checksum_algo,
171                        is_presigned_req,
172                    ) {
173                        (_, _, _, _, true) => {}
174                        (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported, _, false, false, _)
175                        | (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenRequired, true, false, false, _) => {
176                            request.headers_mut().insert("x-amz-sdk-checksum-algorithm", "CRC32");
177                        }
178                        _ => {}
179                    }
180
181                    // We return a bool indicating if the user did set the checksum value, if they did
182                    // we can short circuit and exit the interceptor early.
183                    Ok(user_set_checksum_value)
184                },
185            ))
186            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
187                crate::operation::restore_object::RestoreObjectError,
188            >::new())
189            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
190                crate::operation::restore_object::RestoreObjectError,
191            >::new())
192            .with_retry_classifier(
193                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::restore_object::RestoreObjectError>::builder()
194                    .transient_errors({
195                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
196                        transient_errors.push("InternalError");
197                        ::std::borrow::Cow::Owned(transient_errors)
198                    })
199                    .build(),
200            );
201
202        ::std::borrow::Cow::Owned(rcb)
203    }
204}
205
206#[derive(Debug)]
207struct RestoreObjectResponseDeserializer;
208impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for RestoreObjectResponseDeserializer {
209    fn deserialize_nonstreaming(
210        &self,
211        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
212    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
213        let (success, status) = (response.status().is_success(), response.status().as_u16());
214        let headers = response.headers();
215        let body = response.body().bytes().expect("body loaded");
216        #[allow(unused_mut)]
217        let mut force_error = false;
218        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
219        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
220            force_error = true;
221        }
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_restore_object::de_restore_object_http_error(status, headers, body)
225        } else {
226            crate::protocol_serde::shape_restore_object::de_restore_object_http_response(status, headers, body)
227        };
228        crate::protocol_serde::type_erase_result(parse_result)
229    }
230}
231#[derive(Debug)]
232struct RestoreObjectRequestSerializer;
233impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for RestoreObjectRequestSerializer {
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::restore_object::RestoreObjectInput>()
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::restore_object::RestoreObjectInput,
251                output: &mut ::std::string::String,
252            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
253                use ::std::fmt::Write as _;
254                let input_1 = &_input.key;
255                let input_1 = input_1
256                    .as_ref()
257                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
258                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
259                if key.is_empty() {
260                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
261                        "key",
262                        "cannot be empty or unset",
263                    ));
264                }
265                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
266                ::std::result::Result::Ok(())
267            }
268            fn uri_query(
269                _input: &crate::operation::restore_object::RestoreObjectInput,
270                mut output: &mut ::std::string::String,
271            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
272                let mut query = ::aws_smithy_http::query::Writer::new(output);
273                query.push_v("restore");
274                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
275                    {
276                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
277                    }
278                }
279                ::std::result::Result::Ok(())
280            }
281            #[allow(clippy::unnecessary_wraps)]
282            fn update_http_builder(
283                input: &crate::operation::restore_object::RestoreObjectInput,
284                builder: ::http::request::Builder,
285            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
286                let mut uri = ::std::string::String::new();
287                uri_base(input, &mut uri)?;
288                uri_query(input, &mut uri)?;
289                let builder = crate::protocol_serde::shape_restore_object::ser_restore_object_headers(input, builder)?;
290                ::std::result::Result::Ok(builder.method("POST").uri(uri))
291            }
292            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
293            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
294            builder
295        };
296        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_restore_object_input::ser_restore_request_http_payload(
297            &input.restore_request,
298        )?);
299        if let Some(content_length) = body.content_length() {
300            let content_length = content_length.to_string();
301            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
302        }
303        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
304    }
305}
306#[derive(Debug)]
307struct RestoreObjectEndpointParamsInterceptor;
308
309impl ::aws_smithy_runtime_api::client::interceptors::Intercept for RestoreObjectEndpointParamsInterceptor {
310    fn name(&self) -> &'static str {
311        "RestoreObjectEndpointParamsInterceptor"
312    }
313
314    fn read_before_execution(
315        &self,
316        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
317            '_,
318            ::aws_smithy_runtime_api::client::interceptors::context::Input,
319            ::aws_smithy_runtime_api::client::interceptors::context::Output,
320            ::aws_smithy_runtime_api::client::interceptors::context::Error,
321        >,
322        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
323    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
324        let _input = context
325            .input()
326            .downcast_ref::<RestoreObjectInput>()
327            .ok_or("failed to downcast to RestoreObjectInput")?;
328
329        let params = crate::config::endpoint::Params::builder()
330            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
331            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
332            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
333            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
334            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
335            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
336            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
337            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
338            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
339            .set_bucket(Some(
340                _input
341                    .bucket
342                    .clone()
343                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
344                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
345            ))
346            .build()
347            .map_err(|err| {
348                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
349            })?;
350        cfg.interceptor_state()
351            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
352        ::std::result::Result::Ok(())
353    }
354}
355
356// The get_* functions below are generated from JMESPath expressions in the
357// operationContextParams trait. They target the operation's input shape.
358
359/// Error type for the `RestoreObjectError` operation.
360#[non_exhaustive]
361#[derive(::std::fmt::Debug)]
362pub enum RestoreObjectError {
363    /// <p>This action is not allowed against this storage tier.</p>
364    ObjectAlreadyInActiveTierError(crate::types::error::ObjectAlreadyInActiveTierError),
365    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
366    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
367    variable wildcard pattern and check `.code()`:
368     \
369    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
370     \
371    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-RestoreObjectError) for what information is available for the error.")]
372    Unhandled(crate::error::sealed_unhandled::Unhandled),
373}
374impl RestoreObjectError {
375    /// Creates the `RestoreObjectError::Unhandled` variant from any error type.
376    pub fn unhandled(
377        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
378    ) -> Self {
379        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
380            source: err.into(),
381            meta: ::std::default::Default::default(),
382        })
383    }
384
385    /// Creates the `RestoreObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
386    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
387        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
388            source: err.clone().into(),
389            meta: err,
390        })
391    }
392    ///
393    /// Returns error metadata, which includes the error code, message,
394    /// request ID, and potentially additional information.
395    ///
396    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
397        match self {
398            Self::ObjectAlreadyInActiveTierError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
399            Self::Unhandled(e) => &e.meta,
400        }
401    }
402    /// Returns `true` if the error kind is `RestoreObjectError::ObjectAlreadyInActiveTierError`.
403    pub fn is_object_already_in_active_tier_error(&self) -> bool {
404        matches!(self, Self::ObjectAlreadyInActiveTierError(_))
405    }
406}
407impl ::std::error::Error for RestoreObjectError {
408    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
409        match self {
410            Self::ObjectAlreadyInActiveTierError(_inner) => ::std::option::Option::Some(_inner),
411            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
412        }
413    }
414}
415impl ::std::fmt::Display for RestoreObjectError {
416    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
417        match self {
418            Self::ObjectAlreadyInActiveTierError(_inner) => _inner.fmt(f),
419            Self::Unhandled(_inner) => {
420                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
421                    write!(f, "unhandled error ({code})")
422                } else {
423                    f.write_str("unhandled error")
424                }
425            }
426        }
427    }
428}
429impl ::aws_smithy_types::retry::ProvideErrorKind for RestoreObjectError {
430    fn code(&self) -> ::std::option::Option<&str> {
431        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
432    }
433    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
434        ::std::option::Option::None
435    }
436}
437impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for RestoreObjectError {
438    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
439        match self {
440            Self::ObjectAlreadyInActiveTierError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
441            Self::Unhandled(_inner) => &_inner.meta,
442        }
443    }
444}
445impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for RestoreObjectError {
446    fn create_unhandled_error(
447        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
448        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
449    ) -> Self {
450        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
451            source,
452            meta: meta.unwrap_or_default(),
453        })
454    }
455}
456impl crate::s3_request_id::RequestIdExt for crate::operation::restore_object::RestoreObjectError {
457    fn extended_request_id(&self) -> Option<&str> {
458        self.meta().extended_request_id()
459    }
460}
461impl ::aws_types::request_id::RequestId for crate::operation::restore_object::RestoreObjectError {
462    fn request_id(&self) -> Option<&str> {
463        self.meta().request_id()
464    }
465}
466
467pub use crate::operation::restore_object::_restore_object_output::RestoreObjectOutput;
468
469pub use crate::operation::restore_object::_restore_object_input::RestoreObjectInput;
470
471mod _restore_object_input;
472
473mod _restore_object_output;
474
475/// Builders
476pub mod builders;
aws_sdk_s3/operation/restore_object.rs

aws_sdk_s3/operation/
restore_object.rs
