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