aws_sdk_s3/operation/
put_object_acl.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PutObjectAcl`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PutObjectAcl;
6impl PutObjectAcl {
7    /// Creates a new `PutObjectAcl`
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_object_acl::PutObjectAclInput,
14    ) -> ::std::result::Result<
15        crate::operation::put_object_acl::PutObjectAclOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::put_object_acl::PutObjectAclError,
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_object_acl::PutObjectAclError>()
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_object_acl::PutObjectAclOutput>()
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_object_acl::PutObjectAclInput,
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", "PutObjectAcl", 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 PutObjectAcl {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PutObjectAcl");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            PutObjectAclRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            PutObjectAclResponseDeserializer,
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("PutObjectAcl", "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("PutObjectAcl")
121            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
122            .with_interceptor(PutObjectAclEndpointParamsInterceptor)
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_object_acl::PutObjectAclInput = 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_object_acl::PutObjectAclError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::put_object_acl::PutObjectAclError,
143            >::new())
144            .with_retry_classifier(
145                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::put_object_acl::PutObjectAclError>::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 PutObjectAclResponseDeserializer;
160impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PutObjectAclResponseDeserializer {
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_object_acl::de_put_object_acl_http_error(status, headers, body)
177        } else {
178            crate::protocol_serde::shape_put_object_acl::de_put_object_acl_http_response(status, headers, body)
179        };
180        crate::protocol_serde::type_erase_result(parse_result)
181    }
182}
183#[derive(Debug)]
184struct PutObjectAclRequestSerializer;
185impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PutObjectAclRequestSerializer {
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_object_acl::PutObjectAclInput>()
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_object_acl::PutObjectAclInput,
202                output: &mut ::std::string::String,
203            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
204                use ::std::fmt::Write as _;
205                let input_1 = &_input.key;
206                let input_1 = input_1
207                    .as_ref()
208                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
209                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
210                if key.is_empty() {
211                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
212                        "key",
213                        "cannot be empty or unset",
214                    ));
215                }
216                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
217                ::std::result::Result::Ok(())
218            }
219            fn uri_query(
220                _input: &crate::operation::put_object_acl::PutObjectAclInput,
221                mut output: &mut ::std::string::String,
222            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
223                let mut query = ::aws_smithy_http::query::Writer::new(output);
224                query.push_v("acl");
225                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
226                    {
227                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
228                    }
229                }
230                ::std::result::Result::Ok(())
231            }
232            #[allow(clippy::unnecessary_wraps)]
233            fn update_http_builder(
234                input: &crate::operation::put_object_acl::PutObjectAclInput,
235                builder: ::http::request::Builder,
236            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
237                let mut uri = ::std::string::String::new();
238                uri_base(input, &mut uri)?;
239                uri_query(input, &mut uri)?;
240                let builder = crate::protocol_serde::shape_put_object_acl::ser_put_object_acl_headers(input, builder)?;
241                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
242            }
243            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
244            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
245            builder
246        };
247        let body = ::aws_smithy_types::body::SdkBody::from(
248            crate::protocol_serde::shape_put_object_acl_input::ser_access_control_policy_http_payload(&input.access_control_policy)?,
249        );
250        if let Some(content_length) = body.content_length() {
251            let content_length = content_length.to_string();
252            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
253        }
254        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
255    }
256}
257#[derive(Debug)]
258struct PutObjectAclEndpointParamsInterceptor;
259
260impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PutObjectAclEndpointParamsInterceptor {
261    fn name(&self) -> &'static str {
262        "PutObjectAclEndpointParamsInterceptor"
263    }
264
265    fn read_before_execution(
266        &self,
267        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
268            '_,
269            ::aws_smithy_runtime_api::client::interceptors::context::Input,
270            ::aws_smithy_runtime_api::client::interceptors::context::Output,
271            ::aws_smithy_runtime_api::client::interceptors::context::Error,
272        >,
273        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
274    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
275        let _input = context
276            .input()
277            .downcast_ref::<PutObjectAclInput>()
278            .ok_or("failed to downcast to PutObjectAclInput")?;
279
280        let params = crate::config::endpoint::Params::builder()
281            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
282            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
283            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
284            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
285            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
286            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
287            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
288            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
289            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
290            .set_bucket(Some(
291                _input
292                    .bucket
293                    .clone()
294                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
295                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
296            ))
297            .set_key(Some(
298                _input
299                    .key
300                    .clone()
301                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
302                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "A required field was not set"))?,
303            ))
304            .build()
305            .map_err(|err| {
306                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
307            })?;
308        cfg.interceptor_state()
309            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
310        ::std::result::Result::Ok(())
311    }
312}
313
314// The get_* functions below are generated from JMESPath expressions in the
315// operationContextParams trait. They target the operation's input shape.
316
317/// Error type for the `PutObjectAclError` operation.
318#[non_exhaustive]
319#[derive(::std::fmt::Debug)]
320pub enum PutObjectAclError {
321    /// <p>The specified key does not exist.</p>
322    NoSuchKey(crate::types::error::NoSuchKey),
323    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
324    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
325    variable wildcard pattern and check `.code()`:
326     \
327    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
328     \
329    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-PutObjectAclError) for what information is available for the error.")]
330    Unhandled(crate::error::sealed_unhandled::Unhandled),
331}
332impl PutObjectAclError {
333    /// Creates the `PutObjectAclError::Unhandled` variant from any error type.
334    pub fn unhandled(
335        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
336    ) -> Self {
337        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
338            source: err.into(),
339            meta: ::std::default::Default::default(),
340        })
341    }
342
343    /// Creates the `PutObjectAclError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
344    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
345        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
346            source: err.clone().into(),
347            meta: err,
348        })
349    }
350    ///
351    /// Returns error metadata, which includes the error code, message,
352    /// request ID, and potentially additional information.
353    ///
354    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
355        match self {
356            Self::NoSuchKey(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357            Self::Unhandled(e) => &e.meta,
358        }
359    }
360    /// Returns `true` if the error kind is `PutObjectAclError::NoSuchKey`.
361    pub fn is_no_such_key(&self) -> bool {
362        matches!(self, Self::NoSuchKey(_))
363    }
364}
365impl ::std::error::Error for PutObjectAclError {
366    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
367        match self {
368            Self::NoSuchKey(_inner) => ::std::option::Option::Some(_inner),
369            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
370        }
371    }
372}
373impl ::std::fmt::Display for PutObjectAclError {
374    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
375        match self {
376            Self::NoSuchKey(_inner) => _inner.fmt(f),
377            Self::Unhandled(_inner) => {
378                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
379                    write!(f, "unhandled error ({code})")
380                } else {
381                    f.write_str("unhandled error")
382                }
383            }
384        }
385    }
386}
387impl ::aws_smithy_types::retry::ProvideErrorKind for PutObjectAclError {
388    fn code(&self) -> ::std::option::Option<&str> {
389        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
390    }
391    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
392        ::std::option::Option::None
393    }
394}
395impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for PutObjectAclError {
396    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
397        match self {
398            Self::NoSuchKey(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::Unhandled(_inner) => &_inner.meta,
400        }
401    }
402}
403impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for PutObjectAclError {
404    fn create_unhandled_error(
405        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
406        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
407    ) -> Self {
408        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
409            source,
410            meta: meta.unwrap_or_default(),
411        })
412    }
413}
414impl crate::s3_request_id::RequestIdExt for crate::operation::put_object_acl::PutObjectAclError {
415    fn extended_request_id(&self) -> Option<&str> {
416        self.meta().extended_request_id()
417    }
418}
419impl ::aws_types::request_id::RequestId for crate::operation::put_object_acl::PutObjectAclError {
420    fn request_id(&self) -> Option<&str> {
421        self.meta().request_id()
422    }
423}
424
425pub use crate::operation::put_object_acl::_put_object_acl_output::PutObjectAclOutput;
426
427pub use crate::operation::put_object_acl::_put_object_acl_input::PutObjectAclInput;
428
429mod _put_object_acl_input;
430
431mod _put_object_acl_output;
432
433/// Builders
434pub mod builders;