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

aws_sdk_s3/operation/
get_object_lock_configuration.rs
