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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "RestoreObject", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64            #[cfg(feature = "sigv4a")]
65            {
66                ::aws_runtime::auth::sigv4a::SCHEME_ID
67            },
68            crate::s3_express::auth::SCHEME_ID,
69            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
70        ]));
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for RestoreObject {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("RestoreObject");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            RestoreObjectRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            RestoreObjectResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("RestoreObject", "s3"));
100        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
101        signing_options.double_uri_encode = false;
102        signing_options.content_sha256_header = true;
103        signing_options.normalize_uri_path = false;
104        signing_options.payload_override = None;
105
106        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
107            signing_options,
108            ..::std::default::Default::default()
109        });
110
111        ::std::option::Option::Some(cfg.freeze())
112    }
113
114    fn runtime_components(
115        &self,
116        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
117    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
118        #[allow(unused_mut)]
119        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("RestoreObject")
120            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
121            .with_interceptor(RestoreObjectEndpointParamsInterceptor)
122            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
123                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
124                    let input: &crate::operation::restore_object::RestoreObjectInput = input.downcast_ref().expect("correct type");
125                    let checksum_algorithm = input.checksum_algorithm();
126                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
127                    let checksum_algorithm = match checksum_algorithm {
128                        Some(algo) => Some(
129                            algo.parse::<::aws_smithy_checksums::ChecksumAlgorithm>()
130                                .map_err(::aws_smithy_types::error::operation::BuildError::other)?,
131                        ),
132                        None => None,
133                    };
134                    ::std::result::Result::<_, ::aws_smithy_runtime_api::box_error::BoxError>::Ok(checksum_algorithm)
135                },
136            ))
137            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
138                crate::operation::restore_object::RestoreObjectError,
139            >::new())
140            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
141                crate::operation::restore_object::RestoreObjectError,
142            >::new())
143            .with_retry_classifier(
144                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::restore_object::RestoreObjectError>::builder()
145                    .transient_errors({
146                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
147                        transient_errors.push("InternalError");
148                        ::std::borrow::Cow::Owned(transient_errors)
149                    })
150                    .build(),
151            );
152
153        ::std::borrow::Cow::Owned(rcb)
154    }
155}
156
157#[derive(Debug)]
158struct RestoreObjectResponseDeserializer;
159impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for RestoreObjectResponseDeserializer {
160    fn deserialize_nonstreaming(
161        &self,
162        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
163    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
164        let (success, status) = (response.status().is_success(), response.status().as_u16());
165        let headers = response.headers();
166        let body = response.body().bytes().expect("body loaded");
167        #[allow(unused_mut)]
168        let mut force_error = false;
169        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
170        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
171            force_error = true;
172        }
173        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
174        let parse_result = if !success && status != 200 || force_error {
175            crate::protocol_serde::shape_restore_object::de_restore_object_http_error(status, headers, body)
176        } else {
177            crate::protocol_serde::shape_restore_object::de_restore_object_http_response(status, headers, body)
178        };
179        crate::protocol_serde::type_erase_result(parse_result)
180    }
181}
182#[derive(Debug)]
183struct RestoreObjectRequestSerializer;
184impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for RestoreObjectRequestSerializer {
185    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
186    fn serialize_input(
187        &self,
188        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
189        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
190    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
191        let input = input
192            .downcast::<crate::operation::restore_object::RestoreObjectInput>()
193            .expect("correct type");
194        let _header_serialization_settings = _cfg
195            .load::<crate::serialization_settings::HeaderSerializationSettings>()
196            .cloned()
197            .unwrap_or_default();
198        let mut request_builder = {
199            fn uri_base(
200                _input: &crate::operation::restore_object::RestoreObjectInput,
201                output: &mut ::std::string::String,
202            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
203                use ::std::fmt::Write as _;
204                let input_1 = &_input.key;
205                let input_1 = input_1
206                    .as_ref()
207                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
208                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
209                if key.is_empty() {
210                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
211                        "key",
212                        "cannot be empty or unset",
213                    ));
214                }
215                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
216                ::std::result::Result::Ok(())
217            }
218            fn uri_query(
219                _input: &crate::operation::restore_object::RestoreObjectInput,
220                mut output: &mut ::std::string::String,
221            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
222                let mut query = ::aws_smithy_http::query::Writer::new(output);
223                query.push_v("restore");
224                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
225                    {
226                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
227                    }
228                }
229                ::std::result::Result::Ok(())
230            }
231            #[allow(clippy::unnecessary_wraps)]
232            fn update_http_builder(
233                input: &crate::operation::restore_object::RestoreObjectInput,
234                builder: ::http::request::Builder,
235            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
236                let mut uri = ::std::string::String::new();
237                uri_base(input, &mut uri)?;
238                uri_query(input, &mut uri)?;
239                let builder = crate::protocol_serde::shape_restore_object::ser_restore_object_headers(input, builder)?;
240                ::std::result::Result::Ok(builder.method("POST").uri(uri))
241            }
242            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
243            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
244            builder
245        };
246        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_restore_object_input::ser_restore_request_http_payload(
247            &input.restore_request,
248        )?);
249        if let Some(content_length) = body.content_length() {
250            let content_length = content_length.to_string();
251            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
252        }
253        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
254    }
255}
256#[derive(Debug)]
257struct RestoreObjectEndpointParamsInterceptor;
258
259impl ::aws_smithy_runtime_api::client::interceptors::Intercept for RestoreObjectEndpointParamsInterceptor {
260    fn name(&self) -> &'static str {
261        "RestoreObjectEndpointParamsInterceptor"
262    }
263
264    fn read_before_execution(
265        &self,
266        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
267            '_,
268            ::aws_smithy_runtime_api::client::interceptors::context::Input,
269            ::aws_smithy_runtime_api::client::interceptors::context::Output,
270            ::aws_smithy_runtime_api::client::interceptors::context::Error,
271        >,
272        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
273    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
274        let _input = context
275            .input()
276            .downcast_ref::<RestoreObjectInput>()
277            .ok_or("failed to downcast to RestoreObjectInput")?;
278
279        let params = crate::config::endpoint::Params::builder()
280            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
281            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
282            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
283            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
284            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
285            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
286            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
287            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
288            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
289            .set_bucket(Some(
290                _input
291                    .bucket
292                    .clone()
293                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
294                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
295            ))
296            .build()
297            .map_err(|err| {
298                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
299            })?;
300        cfg.interceptor_state()
301            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
302        ::std::result::Result::Ok(())
303    }
304}
305
306// The get_* functions below are generated from JMESPath expressions in the
307// operationContextParams trait. They target the operation's input shape.
308
309/// Error type for the `RestoreObjectError` operation.
310#[non_exhaustive]
311#[derive(::std::fmt::Debug)]
312pub enum RestoreObjectError {
313    /// <p>This action is not allowed against this storage tier.</p>
314    ObjectAlreadyInActiveTierError(crate::types::error::ObjectAlreadyInActiveTierError),
315    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
316    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
317    variable wildcard pattern and check `.code()`:
318     \
319    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
320     \
321    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-RestoreObjectError) for what information is available for the error.")]
322    Unhandled(crate::error::sealed_unhandled::Unhandled),
323}
324impl RestoreObjectError {
325    /// Creates the `RestoreObjectError::Unhandled` variant from any error type.
326    pub fn unhandled(
327        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
328    ) -> Self {
329        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
330            source: err.into(),
331            meta: ::std::default::Default::default(),
332        })
333    }
334
335    /// Creates the `RestoreObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
336    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
337        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
338            source: err.clone().into(),
339            meta: err,
340        })
341    }
342    ///
343    /// Returns error metadata, which includes the error code, message,
344    /// request ID, and potentially additional information.
345    ///
346    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
347        match self {
348            Self::ObjectAlreadyInActiveTierError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::Unhandled(e) => &e.meta,
350        }
351    }
352    /// Returns `true` if the error kind is `RestoreObjectError::ObjectAlreadyInActiveTierError`.
353    pub fn is_object_already_in_active_tier_error(&self) -> bool {
354        matches!(self, Self::ObjectAlreadyInActiveTierError(_))
355    }
356}
357impl ::std::error::Error for RestoreObjectError {
358    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
359        match self {
360            Self::ObjectAlreadyInActiveTierError(_inner) => ::std::option::Option::Some(_inner),
361            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
362        }
363    }
364}
365impl ::std::fmt::Display for RestoreObjectError {
366    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
367        match self {
368            Self::ObjectAlreadyInActiveTierError(_inner) => _inner.fmt(f),
369            Self::Unhandled(_inner) => {
370                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
371                    write!(f, "unhandled error ({code})")
372                } else {
373                    f.write_str("unhandled error")
374                }
375            }
376        }
377    }
378}
379impl ::aws_smithy_types::retry::ProvideErrorKind for RestoreObjectError {
380    fn code(&self) -> ::std::option::Option<&str> {
381        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
382    }
383    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
384        ::std::option::Option::None
385    }
386}
387impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for RestoreObjectError {
388    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
389        match self {
390            Self::ObjectAlreadyInActiveTierError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::Unhandled(_inner) => &_inner.meta,
392        }
393    }
394}
395impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for RestoreObjectError {
396    fn create_unhandled_error(
397        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
398        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
399    ) -> Self {
400        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
401            source,
402            meta: meta.unwrap_or_default(),
403        })
404    }
405}
406impl crate::s3_request_id::RequestIdExt for crate::operation::restore_object::RestoreObjectError {
407    fn extended_request_id(&self) -> Option<&str> {
408        self.meta().extended_request_id()
409    }
410}
411impl ::aws_types::request_id::RequestId for crate::operation::restore_object::RestoreObjectError {
412    fn request_id(&self) -> Option<&str> {
413        self.meta().request_id()
414    }
415}
416
417pub use crate::operation::restore_object::_restore_object_output::RestoreObjectOutput;
418
419pub use crate::operation::restore_object::_restore_object_input::RestoreObjectInput;
420
421mod _restore_object_input;
422
423mod _restore_object_output;
424
425/// Builders
426pub mod builders;
aws_sdk_s3/operation/restore_object.rs

aws_sdk_s3/operation/
restore_object.rs
