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        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "s3.GetObjectAttributes",
36                "rpc.service" = "s3",
37                "rpc.method" = "GetObjectAttributes",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::get_object_attributes::GetObjectAttributesOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::get_object_attributes::GetObjectAttributesInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "GetObjectAttributes", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74            #[cfg(feature = "sigv4a")]
75            {
76                ::aws_runtime::auth::sigv4a::SCHEME_ID
77            },
78            crate::s3_express::auth::SCHEME_ID,
79            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
80        ]));
81        if let ::std::option::Option::Some(config_override) = config_override {
82            for plugin in config_override.runtime_plugins.iter().cloned() {
83                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
84            }
85            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
86                config_override,
87                client_config.config.clone(),
88                &client_config.runtime_components,
89            ));
90        }
91        runtime_plugins
92    }
93}
94impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetObjectAttributes {
95    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetObjectAttributes");
97
98        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99            GetObjectAttributesRequestSerializer,
100        ));
101        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102            GetObjectAttributesResponseDeserializer,
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetObjectAttributes", "s3"));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = false;
112        signing_options.content_sha256_header = true;
113        signing_options.normalize_uri_path = false;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129                    let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetObjectAttributes")
130                            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131.with_interceptor(GetObjectAttributesEndpointParamsInterceptor)
132                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::get_object_attributes::GetObjectAttributesError>::new())
133.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::get_object_attributes::GetObjectAttributesError>::new())
134.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::get_object_attributes::GetObjectAttributesError>::builder().transient_errors({
135                                            let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
136                                            transient_errors.push("InternalError");
137                                            ::std::borrow::Cow::Owned(transient_errors)
138                                            }).build());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct GetObjectAttributesResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetObjectAttributesResponseDeserializer {
147    fn deserialize_nonstreaming(
148        &self,
149        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
151        let (success, status) = (response.status().is_success(), response.status().as_u16());
152        let headers = response.headers();
153        let body = response.body().bytes().expect("body loaded");
154        #[allow(unused_mut)]
155        let mut force_error = false;
156        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
157        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
158            force_error = true;
159        }
160        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
161        let parse_result = if !success && status != 200 || force_error {
162            crate::protocol_serde::shape_get_object_attributes::de_get_object_attributes_http_error(status, headers, body)
163        } else {
164            crate::protocol_serde::shape_get_object_attributes::de_get_object_attributes_http_response(status, headers, body)
165        };
166        crate::protocol_serde::type_erase_result(parse_result)
167    }
168}
169#[derive(Debug)]
170struct GetObjectAttributesRequestSerializer;
171impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetObjectAttributesRequestSerializer {
172    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
173    fn serialize_input(
174        &self,
175        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
176        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
177    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
178        let input = input
179            .downcast::<crate::operation::get_object_attributes::GetObjectAttributesInput>()
180            .expect("correct type");
181        let _header_serialization_settings = _cfg
182            .load::<crate::serialization_settings::HeaderSerializationSettings>()
183            .cloned()
184            .unwrap_or_default();
185        let mut request_builder = {
186            fn uri_base(
187                _input: &crate::operation::get_object_attributes::GetObjectAttributesInput,
188                output: &mut ::std::string::String,
189            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
190                use ::std::fmt::Write as _;
191                let input_1 = &_input.key;
192                let input_1 = input_1
193                    .as_ref()
194                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
195                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
196                if key.is_empty() {
197                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
198                        "key",
199                        "cannot be empty or unset",
200                    ));
201                }
202                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
203                ::std::result::Result::Ok(())
204            }
205            fn uri_query(
206                _input: &crate::operation::get_object_attributes::GetObjectAttributesInput,
207                mut output: &mut ::std::string::String,
208            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
209                let mut query = ::aws_smithy_http::query::Writer::new(output);
210                query.push_v("attributes");
211                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
212                    {
213                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
214                    }
215                }
216                ::std::result::Result::Ok(())
217            }
218            #[allow(clippy::unnecessary_wraps)]
219            fn update_http_builder(
220                input: &crate::operation::get_object_attributes::GetObjectAttributesInput,
221                builder: ::http::request::Builder,
222            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
223                let mut uri = ::std::string::String::new();
224                uri_base(input, &mut uri)?;
225                uri_query(input, &mut uri)?;
226                let builder = crate::protocol_serde::shape_get_object_attributes::ser_get_object_attributes_headers(input, builder)?;
227                ::std::result::Result::Ok(builder.method("GET").uri(uri))
228            }
229            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
230            builder
231        };
232        let body = ::aws_smithy_types::body::SdkBody::from("");
233
234        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
235    }
236}
237#[derive(Debug)]
238struct GetObjectAttributesEndpointParamsInterceptor;
239
240impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetObjectAttributesEndpointParamsInterceptor {
241    fn name(&self) -> &'static str {
242        "GetObjectAttributesEndpointParamsInterceptor"
243    }
244
245    fn read_before_execution(
246        &self,
247        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
248            '_,
249            ::aws_smithy_runtime_api::client::interceptors::context::Input,
250            ::aws_smithy_runtime_api::client::interceptors::context::Output,
251            ::aws_smithy_runtime_api::client::interceptors::context::Error,
252        >,
253        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
254    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
255        let _input = context
256            .input()
257            .downcast_ref::<GetObjectAttributesInput>()
258            .ok_or("failed to downcast to GetObjectAttributesInput")?;
259
260        let params = crate::config::endpoint::Params::builder()
261            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
262            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
263            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
264            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
265            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
266            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
267            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
268            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
269            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
270            .set_bucket(Some(
271                _input
272                    .bucket
273                    .clone()
274                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
275                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
276            ))
277            .build()
278            .map_err(|err| {
279                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
280            })?;
281        cfg.interceptor_state()
282            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
283        ::std::result::Result::Ok(())
284    }
285}
286
287// The get_* functions below are generated from JMESPath expressions in the
288// operationContextParams trait. They target the operation's input shape.
289
290/// Error type for the `GetObjectAttributesError` operation.
291#[non_exhaustive]
292#[derive(::std::fmt::Debug)]
293pub enum GetObjectAttributesError {
294    /// <p>The specified key does not exist.</p>
295    NoSuchKey(crate::types::error::NoSuchKey),
296    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
297    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
298    variable wildcard pattern and check `.code()`:
299     \
300    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
301     \
302    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetObjectAttributesError) for what information is available for the error.")]
303    Unhandled(crate::error::sealed_unhandled::Unhandled),
304}
305impl GetObjectAttributesError {
306    /// Creates the `GetObjectAttributesError::Unhandled` variant from any error type.
307    pub fn unhandled(
308        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
309    ) -> Self {
310        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
311            source: err.into(),
312            meta: ::std::default::Default::default(),
313        })
314    }
315
316    /// Creates the `GetObjectAttributesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
317    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
318        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
319            source: err.clone().into(),
320            meta: err,
321        })
322    }
323    ///
324    /// Returns error metadata, which includes the error code, message,
325    /// request ID, and potentially additional information.
326    ///
327    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
328        match self {
329            Self::NoSuchKey(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::Unhandled(e) => &e.meta,
331        }
332    }
333    /// Returns `true` if the error kind is `GetObjectAttributesError::NoSuchKey`.
334    pub fn is_no_such_key(&self) -> bool {
335        matches!(self, Self::NoSuchKey(_))
336    }
337}
338impl ::std::error::Error for GetObjectAttributesError {
339    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
340        match self {
341            Self::NoSuchKey(_inner) => ::std::option::Option::Some(_inner),
342            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
343        }
344    }
345}
346impl ::std::fmt::Display for GetObjectAttributesError {
347    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
348        match self {
349            Self::NoSuchKey(_inner) => _inner.fmt(f),
350            Self::Unhandled(_inner) => {
351                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
352                    write!(f, "unhandled error ({code})")
353                } else {
354                    f.write_str("unhandled error")
355                }
356            }
357        }
358    }
359}
360impl ::aws_smithy_types::retry::ProvideErrorKind for GetObjectAttributesError {
361    fn code(&self) -> ::std::option::Option<&str> {
362        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
363    }
364    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
365        ::std::option::Option::None
366    }
367}
368impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetObjectAttributesError {
369    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
370        match self {
371            Self::NoSuchKey(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::Unhandled(_inner) => &_inner.meta,
373        }
374    }
375}
376impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetObjectAttributesError {
377    fn create_unhandled_error(
378        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
379        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
380    ) -> Self {
381        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
382            source,
383            meta: meta.unwrap_or_default(),
384        })
385    }
386}
387impl crate::s3_request_id::RequestIdExt for crate::operation::get_object_attributes::GetObjectAttributesError {
388    fn extended_request_id(&self) -> Option<&str> {
389        self.meta().extended_request_id()
390    }
391}
392impl ::aws_types::request_id::RequestId for crate::operation::get_object_attributes::GetObjectAttributesError {
393    fn request_id(&self) -> Option<&str> {
394        self.meta().request_id()
395    }
396}
397
398pub use crate::operation::get_object_attributes::_get_object_attributes_output::GetObjectAttributesOutput;
399
400pub use crate::operation::get_object_attributes::_get_object_attributes_input::GetObjectAttributesInput;
401
402mod _get_object_attributes_input;
403
404mod _get_object_attributes_output;
405
406/// Builders
407pub mod builders;
aws_sdk_s3/operation/get_object_attributes.rs

aws_sdk_s3/operation/
get_object_attributes.rs
