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        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "s3.RestoreObject",
36                "rpc.service" = "s3",
37                "rpc.method" = "RestoreObject",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::restore_object::RestoreObjectOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::restore_object::RestoreObjectInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "RestoreObject", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74            #[cfg(feature = "sigv4a")]
75            {
76                ::aws_runtime::auth::sigv4a::SCHEME_ID
77            },
78            crate::s3_express::auth::SCHEME_ID,
79            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
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 RestoreObject {
95    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("RestoreObject");
97
98        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99            RestoreObjectRequestSerializer,
100        ));
101        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102            RestoreObjectResponseDeserializer,
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("RestoreObject", "s3"));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = false;
112        signing_options.content_sha256_header = true;
113        signing_options.normalize_uri_path = false;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("RestoreObject")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(RestoreObjectEndpointParamsInterceptor)
132            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
133                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
134                    let input: &crate::operation::restore_object::RestoreObjectInput = input.downcast_ref().expect("correct type");
135                    let checksum_algorithm = input.checksum_algorithm();
136                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
137                    (checksum_algorithm.map(|s| s.to_string()), false)
138                },
139                |request: &mut ::aws_smithy_runtime_api::http::Request, cfg: &::aws_smithy_types::config_bag::ConfigBag| {
140                    // We check if the user has set any of the checksum values manually
141                    let mut user_set_checksum_value = false;
142                    let headers_to_check =
143                        request
144                            .headers()
145                            .iter()
146                            .filter_map(|(name, _val)| if name.starts_with("x-amz-checksum-") { Some(name) } else { None });
147                    for algo_header in headers_to_check {
148                        if request.headers().get(algo_header).is_some() {
149                            user_set_checksum_value = true;
150                        }
151                    }
152
153                    // We check if the user set the checksum algo manually
154                    let user_set_checksum_algo = request.headers().get("x-amz-sdk-checksum-algorithm").is_some();
155
156                    // This value is set by the user on the SdkConfig to indicate their preference
157                    let request_checksum_calculation = cfg
158                        .load::<::aws_smithy_types::checksum_config::RequestChecksumCalculation>()
159                        .unwrap_or(&::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported);
160
161                    // From the httpChecksum trait
162                    let http_checksum_required = false;
163
164                    let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
165
166                    // If the request is presigned we do not set a default.
167                    // If the RequestChecksumCalculation is WhenSupported and the user has not set a checksum value or algo
168                    // we default to Crc32. If it is WhenRequired and a checksum is required by the trait and the user has not
169                    // set a checksum value or algo we also set the default. In all other cases we do nothing.
170                    match (
171                        request_checksum_calculation,
172                        http_checksum_required,
173                        user_set_checksum_value,
174                        user_set_checksum_algo,
175                        is_presigned_req,
176                    ) {
177                        (_, _, _, _, true) => {}
178                        (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported, _, false, false, _)
179                        | (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenRequired, true, false, false, _) => {
180                            request.headers_mut().insert("x-amz-sdk-checksum-algorithm", "CRC32");
181                        }
182                        _ => {}
183                    }
184
185                    // We return a bool indicating if the user did set the checksum value, if they did
186                    // we can short circuit and exit the interceptor early.
187                    Ok(user_set_checksum_value)
188                },
189            ))
190            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
191                crate::operation::restore_object::RestoreObjectError,
192            >::new())
193            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
194                crate::operation::restore_object::RestoreObjectError,
195            >::new())
196            .with_retry_classifier(
197                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::restore_object::RestoreObjectError>::builder()
198                    .transient_errors({
199                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
200                        transient_errors.push("InternalError");
201                        ::std::borrow::Cow::Owned(transient_errors)
202                    })
203                    .build(),
204            );
205
206        ::std::borrow::Cow::Owned(rcb)
207    }
208}
209
210#[derive(Debug)]
211struct RestoreObjectResponseDeserializer;
212impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for RestoreObjectResponseDeserializer {
213    fn deserialize_nonstreaming(
214        &self,
215        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
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!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
223        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
224            force_error = true;
225        }
226        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
227        let parse_result = if !success && status != 200 || force_error {
228            crate::protocol_serde::shape_restore_object::de_restore_object_http_error(status, headers, body)
229        } else {
230            crate::protocol_serde::shape_restore_object::de_restore_object_http_response(status, headers, body)
231        };
232        crate::protocol_serde::type_erase_result(parse_result)
233    }
234}
235#[derive(Debug)]
236struct RestoreObjectRequestSerializer;
237impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for RestoreObjectRequestSerializer {
238    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
239    fn serialize_input(
240        &self,
241        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
242        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
243    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
244        let input = input
245            .downcast::<crate::operation::restore_object::RestoreObjectInput>()
246            .expect("correct type");
247        let _header_serialization_settings = _cfg
248            .load::<crate::serialization_settings::HeaderSerializationSettings>()
249            .cloned()
250            .unwrap_or_default();
251        let mut request_builder = {
252            fn uri_base(
253                _input: &crate::operation::restore_object::RestoreObjectInput,
254                output: &mut ::std::string::String,
255            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
256                use ::std::fmt::Write as _;
257                let input_1 = &_input.key;
258                let input_1 = input_1
259                    .as_ref()
260                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
261                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
262                if key.is_empty() {
263                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
264                        "key",
265                        "cannot be empty or unset",
266                    ));
267                }
268                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
269                ::std::result::Result::Ok(())
270            }
271            fn uri_query(
272                _input: &crate::operation::restore_object::RestoreObjectInput,
273                mut output: &mut ::std::string::String,
274            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
275                let mut query = ::aws_smithy_http::query::Writer::new(output);
276                query.push_v("restore");
277                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
278                    {
279                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
280                    }
281                }
282                ::std::result::Result::Ok(())
283            }
284            #[allow(clippy::unnecessary_wraps)]
285            fn update_http_builder(
286                input: &crate::operation::restore_object::RestoreObjectInput,
287                builder: ::http::request::Builder,
288            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
289                let mut uri = ::std::string::String::new();
290                uri_base(input, &mut uri)?;
291                uri_query(input, &mut uri)?;
292                let builder = crate::protocol_serde::shape_restore_object::ser_restore_object_headers(input, builder)?;
293                ::std::result::Result::Ok(builder.method("POST").uri(uri))
294            }
295            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
296            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
297            builder
298        };
299        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_restore_object_input::ser_restore_request_http_payload(
300            &input.restore_request,
301        )?);
302        if let Some(content_length) = body.content_length() {
303            let content_length = content_length.to_string();
304            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
305        }
306        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
307    }
308}
309#[derive(Debug)]
310struct RestoreObjectEndpointParamsInterceptor;
311
312impl ::aws_smithy_runtime_api::client::interceptors::Intercept for RestoreObjectEndpointParamsInterceptor {
313    fn name(&self) -> &'static str {
314        "RestoreObjectEndpointParamsInterceptor"
315    }
316
317    fn read_before_execution(
318        &self,
319        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
320            '_,
321            ::aws_smithy_runtime_api::client::interceptors::context::Input,
322            ::aws_smithy_runtime_api::client::interceptors::context::Output,
323            ::aws_smithy_runtime_api::client::interceptors::context::Error,
324        >,
325        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
326    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
327        let _input = context
328            .input()
329            .downcast_ref::<RestoreObjectInput>()
330            .ok_or("failed to downcast to RestoreObjectInput")?;
331
332        let params = crate::config::endpoint::Params::builder()
333            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
334            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
335            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
336            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
337            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
338            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
339            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
340            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
341            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
342            .set_bucket(Some(
343                _input
344                    .bucket
345                    .clone()
346                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
347                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
348            ))
349            .build()
350            .map_err(|err| {
351                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
352            })?;
353        cfg.interceptor_state()
354            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
355        ::std::result::Result::Ok(())
356    }
357}
358
359// The get_* functions below are generated from JMESPath expressions in the
360// operationContextParams trait. They target the operation's input shape.
361
362/// Error type for the `RestoreObjectError` operation.
363#[non_exhaustive]
364#[derive(::std::fmt::Debug)]
365pub enum RestoreObjectError {
366    /// <p>This action is not allowed against this storage tier.</p>
367    ObjectAlreadyInActiveTierError(crate::types::error::ObjectAlreadyInActiveTierError),
368    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
369    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
370    variable wildcard pattern and check `.code()`:
371     \
372    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
373     \
374    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-RestoreObjectError) for what information is available for the error.")]
375    Unhandled(crate::error::sealed_unhandled::Unhandled),
376}
377impl RestoreObjectError {
378    /// Creates the `RestoreObjectError::Unhandled` variant from any error type.
379    pub fn unhandled(
380        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
381    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
383            source: err.into(),
384            meta: ::std::default::Default::default(),
385        })
386    }
387
388    /// Creates the `RestoreObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
389    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
390        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
391            source: err.clone().into(),
392            meta: err,
393        })
394    }
395    ///
396    /// Returns error metadata, which includes the error code, message,
397    /// request ID, and potentially additional information.
398    ///
399    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
400        match self {
401            Self::ObjectAlreadyInActiveTierError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
402            Self::Unhandled(e) => &e.meta,
403        }
404    }
405    /// Returns `true` if the error kind is `RestoreObjectError::ObjectAlreadyInActiveTierError`.
406    pub fn is_object_already_in_active_tier_error(&self) -> bool {
407        matches!(self, Self::ObjectAlreadyInActiveTierError(_))
408    }
409}
410impl ::std::error::Error for RestoreObjectError {
411    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
412        match self {
413            Self::ObjectAlreadyInActiveTierError(_inner) => ::std::option::Option::Some(_inner),
414            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
415        }
416    }
417}
418impl ::std::fmt::Display for RestoreObjectError {
419    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
420        match self {
421            Self::ObjectAlreadyInActiveTierError(_inner) => _inner.fmt(f),
422            Self::Unhandled(_inner) => {
423                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
424                    write!(f, "unhandled error ({code})")
425                } else {
426                    f.write_str("unhandled error")
427                }
428            }
429        }
430    }
431}
432impl ::aws_smithy_types::retry::ProvideErrorKind for RestoreObjectError {
433    fn code(&self) -> ::std::option::Option<&str> {
434        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
435    }
436    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
437        ::std::option::Option::None
438    }
439}
440impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for RestoreObjectError {
441    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
442        match self {
443            Self::ObjectAlreadyInActiveTierError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
444            Self::Unhandled(_inner) => &_inner.meta,
445        }
446    }
447}
448impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for RestoreObjectError {
449    fn create_unhandled_error(
450        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
451        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
452    ) -> Self {
453        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
454            source,
455            meta: meta.unwrap_or_default(),
456        })
457    }
458}
459impl crate::s3_request_id::RequestIdExt for crate::operation::restore_object::RestoreObjectError {
460    fn extended_request_id(&self) -> Option<&str> {
461        self.meta().extended_request_id()
462    }
463}
464impl ::aws_types::request_id::RequestId for crate::operation::restore_object::RestoreObjectError {
465    fn request_id(&self) -> Option<&str> {
466        self.meta().request_id()
467    }
468}
469
470pub use crate::operation::restore_object::_restore_object_output::RestoreObjectOutput;
471
472pub use crate::operation::restore_object::_restore_object_input::RestoreObjectInput;
473
474mod _restore_object_input;
475
476mod _restore_object_output;
477
478/// Builders
479pub mod builders;