Skip to main content

aws_sdk_s3/operation/
get_object_attributes.rs

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