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

aws_sdk_s3/operation/
get_object_lock_configuration.rs
