aws_sdk_s3/operation/
put_bucket_policy.rs

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

aws_sdk_s3/operation/
put_bucket_policy.rs
