aws_sdk_s3/operation/
put_bucket_versioning.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PutBucketVersioning`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PutBucketVersioning;
6impl PutBucketVersioning {
7    /// Creates a new `PutBucketVersioning`
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_bucket_versioning::PutBucketVersioningInput,
14    ) -> ::std::result::Result<
15        crate::operation::put_bucket_versioning::PutBucketVersioningOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::put_bucket_versioning::PutBucketVersioningError,
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_bucket_versioning::PutBucketVersioningError>()
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_bucket_versioning::PutBucketVersioningOutput>()
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_bucket_versioning::PutBucketVersioningInput,
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", "PutBucketVersioning", 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.PutBucketVersioning",
59                "rpc.service" = "S3",
60                "rpc.method" = "PutBucketVersioning",
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 PutBucketVersioning {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PutBucketVersioning");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            PutBucketVersioningRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            PutBucketVersioningResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("PutBucketVersioning")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("PutBucketVersioning", "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("PutBucketVersioning")
127                            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128.with_interceptor(PutBucketVersioningEndpointParamsInterceptor)
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_bucket_versioning::PutBucketVersioningInput = 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_bucket_versioning::PutBucketVersioningError>::new())
192.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::put_bucket_versioning::PutBucketVersioningError>::new())
193.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::put_bucket_versioning::PutBucketVersioningError>::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 PutBucketVersioningResponseDeserializer;
205impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PutBucketVersioningResponseDeserializer {
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_bucket_versioning::de_put_bucket_versioning_http_error(status, headers, body)
222        } else {
223            crate::protocol_serde::shape_put_bucket_versioning::de_put_bucket_versioning_http_response(status, headers, body)
224        };
225        crate::protocol_serde::type_erase_result(parse_result)
226    }
227}
228#[derive(Debug)]
229struct PutBucketVersioningRequestSerializer;
230impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PutBucketVersioningRequestSerializer {
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_bucket_versioning::PutBucketVersioningInput>()
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_bucket_versioning::PutBucketVersioningInput,
248                output: &mut ::std::string::String,
249            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
250                use ::std::fmt::Write as _;
251                ::std::write!(output, "/").expect("formatting should succeed");
252                ::std::result::Result::Ok(())
253            }
254            fn uri_query(
255                _input: &crate::operation::put_bucket_versioning::PutBucketVersioningInput,
256                mut output: &mut ::std::string::String,
257            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
258                let mut query = ::aws_smithy_http::query::Writer::new(output);
259                query.push_v("versioning");
260                ::std::result::Result::Ok(())
261            }
262            #[allow(clippy::unnecessary_wraps)]
263            fn update_http_builder(
264                input: &crate::operation::put_bucket_versioning::PutBucketVersioningInput,
265                builder: ::http::request::Builder,
266            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
267                let mut uri = ::std::string::String::new();
268                uri_base(input, &mut uri)?;
269                uri_query(input, &mut uri)?;
270                let builder = crate::protocol_serde::shape_put_bucket_versioning::ser_put_bucket_versioning_headers(input, builder)?;
271                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
272            }
273            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
274            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
275            builder
276        };
277        let body = ::aws_smithy_types::body::SdkBody::from(
278            crate::protocol_serde::shape_put_bucket_versioning_input::ser_versioning_configuration_http_payload(&input.versioning_configuration)?,
279        );
280        if let Some(content_length) = body.content_length() {
281            let content_length = content_length.to_string();
282            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
283        }
284        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
285    }
286}
287#[derive(Debug)]
288struct PutBucketVersioningEndpointParamsInterceptor;
289
290impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PutBucketVersioningEndpointParamsInterceptor {
291    fn name(&self) -> &'static str {
292        "PutBucketVersioningEndpointParamsInterceptor"
293    }
294
295    fn read_before_execution(
296        &self,
297        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
298            '_,
299            ::aws_smithy_runtime_api::client::interceptors::context::Input,
300            ::aws_smithy_runtime_api::client::interceptors::context::Output,
301            ::aws_smithy_runtime_api::client::interceptors::context::Error,
302        >,
303        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
304    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
305        let _input = context
306            .input()
307            .downcast_ref::<PutBucketVersioningInput>()
308            .ok_or("failed to downcast to PutBucketVersioningInput")?;
309
310        let params = crate::config::endpoint::Params::builder()
311            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
312            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
313            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
314            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
315            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
316            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
317            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
318            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
319            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
320            .set_use_s3_express_control_endpoint(Some(true))
321            .set_bucket(Some(
322                _input
323                    .bucket
324                    .clone()
325                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
326                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
327            ))
328            .build()
329            .map_err(|err| {
330                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
331            })?;
332        cfg.interceptor_state()
333            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
334        ::std::result::Result::Ok(())
335    }
336}
337
338// The get_* functions below are generated from JMESPath expressions in the
339// operationContextParams trait. They target the operation's input shape.
340
341/// Error type for the `PutBucketVersioningError` operation.
342#[non_exhaustive]
343#[derive(::std::fmt::Debug)]
344pub enum PutBucketVersioningError {
345    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
346    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
347    variable wildcard pattern and check `.code()`:
348     \
349    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
350     \
351    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-PutBucketVersioningError) for what information is available for the error.")]
352    Unhandled(crate::error::sealed_unhandled::Unhandled),
353}
354impl PutBucketVersioningError {
355    /// Creates the `PutBucketVersioningError::Unhandled` variant from any error type.
356    pub fn unhandled(
357        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
358    ) -> Self {
359        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
360            source: err.into(),
361            meta: ::std::default::Default::default(),
362        })
363    }
364
365    /// Creates the `PutBucketVersioningError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
366    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
367        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
368            source: err.clone().into(),
369            meta: err,
370        })
371    }
372    ///
373    /// Returns error metadata, which includes the error code, message,
374    /// request ID, and potentially additional information.
375    ///
376    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
377        match self {
378            Self::Unhandled(e) => &e.meta,
379        }
380    }
381}
382impl ::std::error::Error for PutBucketVersioningError {
383    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
384        match self {
385            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
386        }
387    }
388}
389impl ::std::fmt::Display for PutBucketVersioningError {
390    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
391        match self {
392            Self::Unhandled(_inner) => {
393                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
394                    write!(f, "unhandled error ({code})")
395                } else {
396                    f.write_str("unhandled error")
397                }
398            }
399        }
400    }
401}
402impl ::aws_smithy_types::retry::ProvideErrorKind for PutBucketVersioningError {
403    fn code(&self) -> ::std::option::Option<&str> {
404        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
405    }
406    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
407        ::std::option::Option::None
408    }
409}
410impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for PutBucketVersioningError {
411    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
412        match self {
413            Self::Unhandled(_inner) => &_inner.meta,
414        }
415    }
416}
417impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for PutBucketVersioningError {
418    fn create_unhandled_error(
419        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
420        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
421    ) -> Self {
422        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
423            source,
424            meta: meta.unwrap_or_default(),
425        })
426    }
427}
428impl crate::s3_request_id::RequestIdExt for crate::operation::put_bucket_versioning::PutBucketVersioningError {
429    fn extended_request_id(&self) -> Option<&str> {
430        self.meta().extended_request_id()
431    }
432}
433impl ::aws_types::request_id::RequestId for crate::operation::put_bucket_versioning::PutBucketVersioningError {
434    fn request_id(&self) -> Option<&str> {
435        self.meta().request_id()
436    }
437}
438
439pub use crate::operation::put_bucket_versioning::_put_bucket_versioning_output::PutBucketVersioningOutput;
440
441pub use crate::operation::put_bucket_versioning::_put_bucket_versioning_input::PutBucketVersioningInput;
442
443mod _put_bucket_versioning_input;
444
445mod _put_bucket_versioning_output;
446
447/// Builders
448pub mod builders;
aws_sdk_s3/operation/put_bucket_versioning.rs

aws_sdk_s3/operation/
put_bucket_versioning.rs
