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

aws_sdk_s3/operation/
get_object_lock_configuration.rs
