aws_sdk_s3/operation/
put_object_legal_hold.rs

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

aws_sdk_s3/operation/
put_object_legal_hold.rs
