aws_sdk_s3/operation/
get_bucket_encryption.rs

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

aws_sdk_s3/operation/
get_bucket_encryption.rs
