aws_sdk_s3/operation/
put_bucket_request_payment.rs

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