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

aws_sdk_s3/operation/
put_public_access_block.rs
