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