aws_sdk_s3/operation/
get_object_acl.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetObjectAcl`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetObjectAcl;
6impl GetObjectAcl {
7    /// Creates a new `GetObjectAcl`
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::get_object_acl::GetObjectAclInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_object_acl::GetObjectAclOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_object_acl::GetObjectAclError,
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::get_object_acl::GetObjectAclError>()
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::get_object_acl::GetObjectAclOutput>()
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::get_object_acl::GetObjectAclInput,
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", "GetObjectAcl", 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.GetObjectAcl",
59                "rpc.service" = "S3",
60                "rpc.method" = "GetObjectAcl",
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 GetObjectAcl {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetObjectAcl");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            GetObjectAclRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            GetObjectAclResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("GetObjectAcl")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetObjectAcl", "S3"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = false;
108        signing_options.content_sha256_header = true;
109        signing_options.normalize_uri_path = false;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetObjectAcl")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                GetObjectAclTelemetryInputCaptureInterceptor,
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                GetObjectAclEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::get_object_acl::GetObjectAclError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::get_object_acl::GetObjectAclError,
140            >::new())
141            .with_retry_classifier(
142                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::get_object_acl::GetObjectAclError>::builder()
143                    .transient_errors({
144                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
145                        transient_errors.push("InternalError");
146                        ::std::borrow::Cow::Owned(transient_errors)
147                    })
148                    .build(),
149            )
150            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
151                crate::operation::get_object_acl::GetObjectAclError,
152            >::new());
153
154        ::std::borrow::Cow::Owned(rcb)
155    }
156}
157
158#[derive(Debug)]
159struct GetObjectAclTelemetryInputCaptureInterceptor;
160
161#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
162impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetObjectAclTelemetryInputCaptureInterceptor {
163    fn name(&self) -> &'static str {
164        "GetObjectAclTelemetryInputCaptureInterceptor"
165    }
166
167    fn read_before_execution(
168        &self,
169        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
170            '_,
171            ::aws_smithy_runtime_api::client::interceptors::context::Input,
172            ::aws_smithy_runtime_api::client::interceptors::context::Output,
173            ::aws_smithy_runtime_api::client::interceptors::context::Error,
174        >,
175        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
176    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
177        // Nothing to do unless the customer opted in by naming members to record.
178        let ::std::option::Option::Some(requested) = cfg
179            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
180            .filter(|r| !r.is_empty())
181        else {
182            return ::std::result::Result::Ok(());
183        };
184
185        let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetObjectAclInput>() else {
186            // A mismatched input is not this interceptor's concern; skip quietly.
187            return ::std::result::Result::Ok(());
188        };
189
190        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
191        if requested.should_capture("Bucket") {
192            if let ::std::option::Option::Some(value) = input.bucket.as_deref() {
193                captured.insert("Bucket", value);
194            }
195        }
196        if requested.should_capture("Key") {
197            if let ::std::option::Option::Some(value) = input.key.as_deref() {
198                captured.insert("Key", value);
199            }
200        }
201        if requested.should_capture("VersionId") {
202            if let ::std::option::Option::Some(value) = input.version_id.as_deref() {
203                captured.insert("VersionId", value);
204            }
205        }
206        if requested.should_capture("ExpectedBucketOwner") {
207            if let ::std::option::Option::Some(value) = input.expected_bucket_owner.as_deref() {
208                captured.insert("ExpectedBucketOwner", value);
209            }
210        }
211
212        cfg.interceptor_state().store_put(captured);
213        ::std::result::Result::Ok(())
214    }
215}
216#[derive(Debug)]
217struct GetObjectAclResponseDeserializer;
218impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetObjectAclResponseDeserializer {
219    fn deserialize_nonstreaming_with_config(
220        &self,
221        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
222        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
223    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
224        let (success, status) = (response.status().is_success(), response.status().as_u16());
225        let headers = response.headers();
226        let body = response.body().bytes().expect("body loaded");
227        #[allow(unused_mut)]
228        let mut force_error = false;
229        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
230        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
231            force_error = true;
232        }
233        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
234        let parse_result = if !success && status != 200 || force_error {
235            crate::protocol_serde::shape_get_object_acl::de_get_object_acl_http_error(status, headers, body, _cfg)
236        } else {
237            crate::protocol_serde::shape_get_object_acl::de_get_object_acl_http_response(status, headers, body, _cfg)
238        };
239        crate::protocol_serde::type_erase_result(parse_result)
240    }
241}
242#[derive(Debug)]
243struct GetObjectAclRequestSerializer;
244impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetObjectAclRequestSerializer {
245    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
246    fn serialize_input(
247        &self,
248        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
249        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
250    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
251        let input = input
252            .downcast::<crate::operation::get_object_acl::GetObjectAclInput>()
253            .expect("correct type");
254        let _header_serialization_settings = _cfg
255            .load::<crate::serialization_settings::HeaderSerializationSettings>()
256            .cloned()
257            .unwrap_or_default();
258        let mut request_builder = {
259            #[allow(clippy::uninlined_format_args)]
260            fn uri_base(
261                _input: &crate::operation::get_object_acl::GetObjectAclInput,
262                output: &mut ::std::string::String,
263            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
264                use ::std::fmt::Write as _;
265                let input_1 = &_input.key;
266                let input_1 = input_1
267                    .as_ref()
268                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
269                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
270                if key.is_empty() {
271                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
272                        "key",
273                        "cannot be empty or unset",
274                    ));
275                }
276                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
277                ::std::result::Result::Ok(())
278            }
279            fn uri_query(
280                _input: &crate::operation::get_object_acl::GetObjectAclInput,
281                mut output: &mut ::std::string::String,
282            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
283                let mut query = ::aws_smithy_http::query::Writer::new(output);
284                query.push_v("acl");
285                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
286                    {
287                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
288                    }
289                }
290                ::std::result::Result::Ok(())
291            }
292            #[allow(clippy::unnecessary_wraps)]
293            fn update_http_builder(
294                input: &crate::operation::get_object_acl::GetObjectAclInput,
295                builder: ::http_1x::request::Builder,
296            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
297                let mut uri = ::std::string::String::new();
298                uri_base(input, &mut uri)?;
299                uri_query(input, &mut uri)?;
300                let builder = crate::protocol_serde::shape_get_object_acl::ser_get_object_acl_headers(input, builder)?;
301                ::std::result::Result::Ok(builder.method("GET").uri(uri))
302            }
303            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
304            builder
305        };
306        let body = ::aws_smithy_types::body::SdkBody::from("");
307
308        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
309    }
310}
311#[derive(Debug)]
312struct GetObjectAclEndpointParamsInterceptor;
313
314#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
315impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetObjectAclEndpointParamsInterceptor {
316    fn name(&self) -> &'static str {
317        "GetObjectAclEndpointParamsInterceptor"
318    }
319
320    fn read_before_execution(
321        &self,
322        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
323            '_,
324            ::aws_smithy_runtime_api::client::interceptors::context::Input,
325            ::aws_smithy_runtime_api::client::interceptors::context::Output,
326            ::aws_smithy_runtime_api::client::interceptors::context::Error,
327        >,
328        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
329    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
330        let _input = context
331            .input()
332            .downcast_ref::<GetObjectAclInput>()
333            .ok_or("failed to downcast to GetObjectAclInput")?;
334
335        let params = crate::config::endpoint::Params::builder()
336            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
337            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
338            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
339            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
340            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
341            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
342            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
343            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
344            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
345            .set_bucket(Some(
346                _input
347                    .bucket
348                    .clone()
349                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
350                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
351            ))
352            .set_key(Some(
353                _input
354                    .key
355                    .clone()
356                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
357                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "A required field was not set"))?,
358            ))
359            .build()
360            .map_err(|err| {
361                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
362            })?;
363        cfg.interceptor_state()
364            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
365        ::std::result::Result::Ok(())
366    }
367}
368
369// The get_* functions below are generated from JMESPath expressions in the
370// operationContextParams trait. They target the operation's input shape.
371
372/// Error type for the `GetObjectAclError` operation.
373#[non_exhaustive]
374#[derive(::std::fmt::Debug)]
375pub enum GetObjectAclError {
376    /// <p>The specified key does not exist.</p>
377    NoSuchKey(crate::types::error::NoSuchKey),
378    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
379    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
380    variable wildcard pattern and check `.code()`:
381     \
382    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
383     \
384    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetObjectAclError) for what information is available for the error.")]
385    Unhandled(crate::error::sealed_unhandled::Unhandled),
386}
387impl GetObjectAclError {
388    /// Creates the `GetObjectAclError::Unhandled` variant from any error type.
389    pub fn unhandled(
390        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
391    ) -> Self {
392        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
393            source: err.into(),
394            meta: ::std::default::Default::default(),
395        })
396    }
397
398    /// Creates the `GetObjectAclError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
399    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
400        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
401            source: err.clone().into(),
402            meta: err,
403        })
404    }
405    ///
406    /// Returns error metadata, which includes the error code, message,
407    /// request ID, and potentially additional information.
408    ///
409    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
410        match self {
411            Self::NoSuchKey(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
412            Self::Unhandled(e) => &e.meta,
413        }
414    }
415    /// Returns `true` if the error kind is `GetObjectAclError::NoSuchKey`.
416    pub fn is_no_such_key(&self) -> bool {
417        matches!(self, Self::NoSuchKey(_))
418    }
419}
420impl ::std::error::Error for GetObjectAclError {
421    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
422        match self {
423            Self::NoSuchKey(_inner) => ::std::option::Option::Some(_inner),
424            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
425        }
426    }
427}
428impl ::std::fmt::Display for GetObjectAclError {
429    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
430        match self {
431            Self::NoSuchKey(_inner) => _inner.fmt(f),
432            Self::Unhandled(_inner) => {
433                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
434                    write!(f, "unhandled error ({code})")
435                } else {
436                    f.write_str("unhandled error")
437                }
438            }
439        }
440    }
441}
442impl ::aws_smithy_types::retry::ProvideErrorKind for GetObjectAclError {
443    fn code(&self) -> ::std::option::Option<&str> {
444        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
445    }
446    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
447        ::std::option::Option::None
448    }
449}
450impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetObjectAclError {
451    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
452        match self {
453            Self::NoSuchKey(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
454            Self::Unhandled(_inner) => &_inner.meta,
455        }
456    }
457}
458impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetObjectAclError {
459    fn create_unhandled_error(
460        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
461        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
462    ) -> Self {
463        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
464            source,
465            meta: meta.unwrap_or_default(),
466        })
467    }
468}
469impl crate::s3_request_id::RequestIdExt for crate::operation::get_object_acl::GetObjectAclError {
470    fn extended_request_id(&self) -> Option<&str> {
471        self.meta().extended_request_id()
472    }
473}
474impl ::aws_types::request_id::RequestId for crate::operation::get_object_acl::GetObjectAclError {
475    fn request_id(&self) -> Option<&str> {
476        self.meta().request_id()
477    }
478}
479
480pub use crate::operation::get_object_acl::_get_object_acl_input::GetObjectAclInput;
481
482pub use crate::operation::get_object_acl::_get_object_acl_output::GetObjectAclOutput;
483
484mod _get_object_acl_input;
485
486mod _get_object_acl_output;
487
488/// Builders
489pub mod builders;
aws_sdk_s3/operation/get_object_acl.rs

aws_sdk_s3/operation/
get_object_acl.rs
