aws_sdk_s3/operation/
get_object_retention.rs

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

aws_sdk_s3/operation/
get_object_retention.rs
