aws_sdk_s3/operation/
get_bucket_versioning.rs

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