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

aws_sdk_s3/operation/
put_bucket_versioning.rs
