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

aws_sdk_s3/operation/
put_bucket_versioning.rs
