aws_sdk_s3/operation/
get_object_lock_configuration.rs

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