aws_sdk_s3/operation/
put_public_access_block.rs

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