aws_sdk_s3/operation/
put_object_lock_configuration.rs

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

aws_sdk_s3/operation/
put_object_lock_configuration.rs
