aws_sdk_s3/operation/
put_object_retention.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PutObjectRetention`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PutObjectRetention;
6impl PutObjectRetention {
7    /// Creates a new `PutObjectRetention`
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_retention::PutObjectRetentionInput,
14    ) -> ::std::result::Result<
15        crate::operation::put_object_retention::PutObjectRetentionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::put_object_retention::PutObjectRetentionError,
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_retention::PutObjectRetentionError>()
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_retention::PutObjectRetentionOutput>()
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_retention::PutObjectRetentionInput,
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        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("S3", "PutObjectRetention", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "S3.PutObjectRetention",
59                "rpc.service" = "S3",
60                "rpc.method" = "PutObjectRetention",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
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
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for PutObjectRetention {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PutObjectRetention");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            PutObjectRetentionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            PutObjectRetentionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("PutObjectRetention")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("PutObjectRetention", "S3"));
106        cfg.store_put(crate::s3_express::checksum::provide_default_checksum_algorithm());
107        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
108        signing_options.double_uri_encode = false;
109        signing_options.content_sha256_header = true;
110        signing_options.normalize_uri_path = false;
111        signing_options.payload_override = None;
112
113        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
114            signing_options,
115            ..::std::default::Default::default()
116        });
117
118        ::std::option::Option::Some(cfg.freeze())
119    }
120
121    fn runtime_components(
122        &self,
123        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
124    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
125        #[allow(unused_mut)]
126                    let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("PutObjectRetention")
127                            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128.with_interceptor(PutObjectRetentionEndpointParamsInterceptor)
129.with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
130                                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
131                                    let input: &crate::operation::put_object_retention::PutObjectRetentionInput = input.downcast_ref().expect("correct type");
132                                    let checksum_algorithm = input.checksum_algorithm();
133                                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
134                                    (checksum_algorithm.map(|s| s.to_string()), true)
135                                },
136                                |request: &mut ::aws_smithy_runtime_api::http::Request, cfg: &::aws_smithy_types::config_bag::ConfigBag| {
137                                    // We check if the user has set any of the checksum values manually
138                                    let mut user_set_checksum_value = false;
139                                    let headers_to_check = request.headers().iter().filter_map(|(name, _val)| {
140                                        if name.starts_with("x-amz-checksum-") {
141                                            Some(name)
142                                        } else {
143                                            None
144                                        }
145                                    });
146                                    for algo_header in headers_to_check {
147                                        if request.headers().get(algo_header).is_some() {
148                                            user_set_checksum_value = true;
149                                        }
150                                    }
151
152                                    // We check if the user set the checksum algo manually
153                                    let user_set_checksum_algo = request.headers()
154                                        .get("x-amz-sdk-checksum-algorithm")
155                                        .is_some();
156
157                                    // This value is set by the user on the SdkConfig to indicate their preference
158                                    let request_checksum_calculation = cfg
159                                        .load::<::aws_smithy_types::checksum_config::RequestChecksumCalculation>()
160                                        .unwrap_or(&::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported);
161
162                                    // From the httpChecksum trait
163                                    let http_checksum_required = true;
164
165                                    let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
166
167                                    // If the request is presigned we do not set a default.
168                                    // If the RequestChecksumCalculation is WhenSupported and the user has not set a checksum value or algo
169                                    // we set the default. If it is WhenRequired and a checksum is required by the trait and the user has not
170                                    // set a checksum value or algo we also set the default. In all other cases we do nothing.
171                                    match (
172                                        request_checksum_calculation,
173                                        http_checksum_required,
174                                        user_set_checksum_value,
175                                        user_set_checksum_algo,
176                                        is_presigned_req,
177                                    ) {
178                                        (_, _, _, _, true) => {}
179                                        (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported, _, false, false, _)
180                                        | (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenRequired, true, false, false, _) => {
181                                            request.headers_mut().insert("x-amz-sdk-checksum-algorithm", "CRC32");
182                                        }
183                                        _ => {},
184                                    }
185
186                                    // We return a bool indicating if the user did set the checksum value, if they did
187                                    // we can short circuit and exit the interceptor early.
188                                    Ok(user_set_checksum_value)
189                                }
190                                ))
191                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::put_object_retention::PutObjectRetentionError>::new())
192.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::put_object_retention::PutObjectRetentionError>::new())
193.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::put_object_retention::PutObjectRetentionError>::builder().transient_errors({
194                                            let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
195                                            transient_errors.push("InternalError");
196                                            ::std::borrow::Cow::Owned(transient_errors)
197                                            }).build());
198
199        ::std::borrow::Cow::Owned(rcb)
200    }
201}
202
203#[derive(Debug)]
204struct PutObjectRetentionResponseDeserializer;
205impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PutObjectRetentionResponseDeserializer {
206    fn deserialize_nonstreaming(
207        &self,
208        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
209    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
210        let (success, status) = (response.status().is_success(), response.status().as_u16());
211        let headers = response.headers();
212        let body = response.body().bytes().expect("body loaded");
213        #[allow(unused_mut)]
214        let mut force_error = false;
215        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
216        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
217            force_error = true;
218        }
219        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
220        let parse_result = if !success && status != 200 || force_error {
221            crate::protocol_serde::shape_put_object_retention::de_put_object_retention_http_error(status, headers, body)
222        } else {
223            crate::protocol_serde::shape_put_object_retention::de_put_object_retention_http_response(status, headers, body)
224        };
225        crate::protocol_serde::type_erase_result(parse_result)
226    }
227}
228#[derive(Debug)]
229struct PutObjectRetentionRequestSerializer;
230impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PutObjectRetentionRequestSerializer {
231    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
232    fn serialize_input(
233        &self,
234        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
235        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
237        let input = input
238            .downcast::<crate::operation::put_object_retention::PutObjectRetentionInput>()
239            .expect("correct type");
240        let _header_serialization_settings = _cfg
241            .load::<crate::serialization_settings::HeaderSerializationSettings>()
242            .cloned()
243            .unwrap_or_default();
244        let mut request_builder = {
245            #[allow(clippy::uninlined_format_args)]
246            fn uri_base(
247                _input: &crate::operation::put_object_retention::PutObjectRetentionInput,
248                output: &mut ::std::string::String,
249            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
250                use ::std::fmt::Write as _;
251                let input_1 = &_input.key;
252                let input_1 = input_1
253                    .as_ref()
254                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
255                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
256                if key.is_empty() {
257                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
258                        "key",
259                        "cannot be empty or unset",
260                    ));
261                }
262                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
263                ::std::result::Result::Ok(())
264            }
265            fn uri_query(
266                _input: &crate::operation::put_object_retention::PutObjectRetentionInput,
267                mut output: &mut ::std::string::String,
268            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
269                let mut query = ::aws_smithy_http::query::Writer::new(output);
270                query.push_v("retention");
271                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
272                    {
273                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
274                    }
275                }
276                ::std::result::Result::Ok(())
277            }
278            #[allow(clippy::unnecessary_wraps)]
279            fn update_http_builder(
280                input: &crate::operation::put_object_retention::PutObjectRetentionInput,
281                builder: ::http::request::Builder,
282            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
283                let mut uri = ::std::string::String::new();
284                uri_base(input, &mut uri)?;
285                uri_query(input, &mut uri)?;
286                let builder = crate::protocol_serde::shape_put_object_retention::ser_put_object_retention_headers(input, builder)?;
287                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
288            }
289            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
290            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
291            builder
292        };
293        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_put_object_retention_input::ser_retention_http_payload(
294            &input.retention,
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 PutObjectRetentionEndpointParamsInterceptor;
305
306impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PutObjectRetentionEndpointParamsInterceptor {
307    fn name(&self) -> &'static str {
308        "PutObjectRetentionEndpointParamsInterceptor"
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::<PutObjectRetentionInput>()
324            .ok_or("failed to downcast to PutObjectRetentionInput")?;
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 `PutObjectRetentionError` operation.
357#[non_exhaustive]
358#[derive(::std::fmt::Debug)]
359pub enum PutObjectRetentionError {
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-PutObjectRetentionError) for what information is available for the error.")]
367    Unhandled(crate::error::sealed_unhandled::Unhandled),
368}
369impl PutObjectRetentionError {
370    /// Creates the `PutObjectRetentionError::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 `PutObjectRetentionError::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 PutObjectRetentionError {
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 PutObjectRetentionError {
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 PutObjectRetentionError {
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 PutObjectRetentionError {
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 PutObjectRetentionError {
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_retention::PutObjectRetentionError {
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_retention::PutObjectRetentionError {
449    fn request_id(&self) -> Option<&str> {
450        self.meta().request_id()
451    }
452}
453
454pub use crate::operation::put_object_retention::_put_object_retention_output::PutObjectRetentionOutput;
455
456pub use crate::operation::put_object_retention::_put_object_retention_input::PutObjectRetentionInput;
457
458mod _put_object_retention_input;
459
460mod _put_object_retention_output;
461
462/// Builders
463pub mod builders;
aws_sdk_s3/operation/put_object_retention.rs

aws_sdk_s3/operation/
put_object_retention.rs
