aws_sdk_s3/operation/
put_object_legal_hold.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PutObjectLegalHold`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PutObjectLegalHold;
6impl PutObjectLegalHold {
7    /// Creates a new `PutObjectLegalHold`
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::put_object_legal_hold::PutObjectLegalHoldInput,
14    ) -> ::std::result::Result<
15        crate::operation::put_object_legal_hold::PutObjectLegalHoldOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::put_object_legal_hold::PutObjectLegalHoldError,
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::put_object_legal_hold::PutObjectLegalHoldError>()
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::put_object_legal_hold::PutObjectLegalHoldOutput>()
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::put_object_legal_hold::PutObjectLegalHoldInput,
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", "PutObjectLegalHold", 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 PutObjectLegalHold {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PutObjectLegalHold");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            PutObjectLegalHoldRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            PutObjectLegalHoldResponseDeserializer,
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("PutObjectLegalHold", "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        cfg.store_put(crate::s3_express::checksum::provide_default_checksum_algorithm());
111
112        ::std::option::Option::Some(cfg.freeze())
113    }
114
115    fn runtime_components(
116        &self,
117        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
118    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
119        #[allow(unused_mut)]
120        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("PutObjectLegalHold")
121            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
122            .with_interceptor(PutObjectLegalHoldEndpointParamsInterceptor)
123            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
124                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
125                    let input: &crate::operation::put_object_legal_hold::PutObjectLegalHoldInput = input.downcast_ref().expect("correct type");
126                    let checksum_algorithm = input.checksum_algorithm();
127                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str()).or(Some("md5"));
128                    let checksum_algorithm = match checksum_algorithm {
129                        Some(algo) => Some(
130                            algo.parse::<::aws_smithy_checksums::ChecksumAlgorithm>()
131                                .map_err(::aws_smithy_types::error::operation::BuildError::other)?,
132                        ),
133                        None => None,
134                    };
135                    ::std::result::Result::<_, ::aws_smithy_runtime_api::box_error::BoxError>::Ok(checksum_algorithm)
136                },
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::put_object_legal_hold::PutObjectLegalHoldError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::put_object_legal_hold::PutObjectLegalHoldError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::put_object_legal_hold::PutObjectLegalHoldError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct PutObjectLegalHoldResponseDeserializer;
154impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PutObjectLegalHoldResponseDeserializer {
155    fn deserialize_nonstreaming(
156        &self,
157        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
158    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
159        let (success, status) = (response.status().is_success(), response.status().as_u16());
160        let headers = response.headers();
161        let body = response.body().bytes().expect("body loaded");
162        #[allow(unused_mut)]
163        let mut force_error = false;
164        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
165        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
166            force_error = true;
167        }
168        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
169        let parse_result = if !success && status != 200 || force_error {
170            crate::protocol_serde::shape_put_object_legal_hold::de_put_object_legal_hold_http_error(status, headers, body)
171        } else {
172            crate::protocol_serde::shape_put_object_legal_hold::de_put_object_legal_hold_http_response(status, headers, body)
173        };
174        crate::protocol_serde::type_erase_result(parse_result)
175    }
176}
177#[derive(Debug)]
178struct PutObjectLegalHoldRequestSerializer;
179impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PutObjectLegalHoldRequestSerializer {
180    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
181    fn serialize_input(
182        &self,
183        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
184        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
185    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
186        let input = input
187            .downcast::<crate::operation::put_object_legal_hold::PutObjectLegalHoldInput>()
188            .expect("correct type");
189        let _header_serialization_settings = _cfg
190            .load::<crate::serialization_settings::HeaderSerializationSettings>()
191            .cloned()
192            .unwrap_or_default();
193        let mut request_builder = {
194            fn uri_base(
195                _input: &crate::operation::put_object_legal_hold::PutObjectLegalHoldInput,
196                output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                use ::std::fmt::Write as _;
199                let input_1 = &_input.key;
200                let input_1 = input_1
201                    .as_ref()
202                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
203                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
204                if key.is_empty() {
205                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
206                        "key",
207                        "cannot be empty or unset",
208                    ));
209                }
210                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
211                ::std::result::Result::Ok(())
212            }
213            fn uri_query(
214                _input: &crate::operation::put_object_legal_hold::PutObjectLegalHoldInput,
215                mut output: &mut ::std::string::String,
216            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
217                let mut query = ::aws_smithy_http::query::Writer::new(output);
218                query.push_v("legal-hold");
219                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
220                    {
221                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
222                    }
223                }
224                ::std::result::Result::Ok(())
225            }
226            #[allow(clippy::unnecessary_wraps)]
227            fn update_http_builder(
228                input: &crate::operation::put_object_legal_hold::PutObjectLegalHoldInput,
229                builder: ::http::request::Builder,
230            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
231                let mut uri = ::std::string::String::new();
232                uri_base(input, &mut uri)?;
233                uri_query(input, &mut uri)?;
234                let builder = crate::protocol_serde::shape_put_object_legal_hold::ser_put_object_legal_hold_headers(input, builder)?;
235                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
236            }
237            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
238            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
239            builder
240        };
241        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_put_object_legal_hold_input::ser_legal_hold_http_payload(
242            &input.legal_hold,
243        )?);
244        if let Some(content_length) = body.content_length() {
245            let content_length = content_length.to_string();
246            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
247        }
248        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
249    }
250}
251#[derive(Debug)]
252struct PutObjectLegalHoldEndpointParamsInterceptor;
253
254impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PutObjectLegalHoldEndpointParamsInterceptor {
255    fn name(&self) -> &'static str {
256        "PutObjectLegalHoldEndpointParamsInterceptor"
257    }
258
259    fn read_before_execution(
260        &self,
261        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
262            '_,
263            ::aws_smithy_runtime_api::client::interceptors::context::Input,
264            ::aws_smithy_runtime_api::client::interceptors::context::Output,
265            ::aws_smithy_runtime_api::client::interceptors::context::Error,
266        >,
267        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
268    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
269        let _input = context
270            .input()
271            .downcast_ref::<PutObjectLegalHoldInput>()
272            .ok_or("failed to downcast to PutObjectLegalHoldInput")?;
273
274        let params = crate::config::endpoint::Params::builder()
275            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
276            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
277            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
278            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
279            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
280            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
281            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
282            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
283            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
284            .set_bucket(Some(
285                _input
286                    .bucket
287                    .clone()
288                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
289                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
290            ))
291            .build()
292            .map_err(|err| {
293                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
294            })?;
295        cfg.interceptor_state()
296            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
297        ::std::result::Result::Ok(())
298    }
299}
300
301/// Error type for the `PutObjectLegalHoldError` operation.
302#[non_exhaustive]
303#[derive(::std::fmt::Debug)]
304pub enum PutObjectLegalHoldError {
305    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
306    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
307    variable wildcard pattern and check `.code()`:
308     \
309    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
310     \
311    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-PutObjectLegalHoldError) for what information is available for the error.")]
312    Unhandled(crate::error::sealed_unhandled::Unhandled),
313}
314impl PutObjectLegalHoldError {
315    /// Creates the `PutObjectLegalHoldError::Unhandled` variant from any error type.
316    pub fn unhandled(
317        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
318    ) -> Self {
319        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
320            source: err.into(),
321            meta: ::std::default::Default::default(),
322        })
323    }
324
325    /// Creates the `PutObjectLegalHoldError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
326    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
327        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
328            source: err.clone().into(),
329            meta: err,
330        })
331    }
332    ///
333    /// Returns error metadata, which includes the error code, message,
334    /// request ID, and potentially additional information.
335    ///
336    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
337        match self {
338            Self::Unhandled(e) => &e.meta,
339        }
340    }
341}
342impl ::std::error::Error for PutObjectLegalHoldError {
343    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
344        match self {
345            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
346        }
347    }
348}
349impl ::std::fmt::Display for PutObjectLegalHoldError {
350    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
351        match self {
352            Self::Unhandled(_inner) => {
353                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
354                    write!(f, "unhandled error ({code})")
355                } else {
356                    f.write_str("unhandled error")
357                }
358            }
359        }
360    }
361}
362impl ::aws_smithy_types::retry::ProvideErrorKind for PutObjectLegalHoldError {
363    fn code(&self) -> ::std::option::Option<&str> {
364        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
365    }
366    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
367        ::std::option::Option::None
368    }
369}
370impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for PutObjectLegalHoldError {
371    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
372        match self {
373            Self::Unhandled(_inner) => &_inner.meta,
374        }
375    }
376}
377impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for PutObjectLegalHoldError {
378    fn create_unhandled_error(
379        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
380        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
381    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
383            source,
384            meta: meta.unwrap_or_default(),
385        })
386    }
387}
388impl crate::s3_request_id::RequestIdExt for crate::operation::put_object_legal_hold::PutObjectLegalHoldError {
389    fn extended_request_id(&self) -> Option<&str> {
390        self.meta().extended_request_id()
391    }
392}
393impl ::aws_types::request_id::RequestId for crate::operation::put_object_legal_hold::PutObjectLegalHoldError {
394    fn request_id(&self) -> Option<&str> {
395        self.meta().request_id()
396    }
397}
398
399pub use crate::operation::put_object_legal_hold::_put_object_legal_hold_output::PutObjectLegalHoldOutput;
400
401pub use crate::operation::put_object_legal_hold::_put_object_legal_hold_input::PutObjectLegalHoldInput;
402
403mod _put_object_legal_hold_input;
404
405mod _put_object_legal_hold_output;
406
407/// Builders
408pub mod builders;
aws_sdk_s3/operation/put_object_legal_hold.rs

aws_sdk_s3/operation/
put_object_legal_hold.rs
