aws_sdk_s3/operation/
get_bucket_policy.rs

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

aws_sdk_s3/operation/
get_bucket_policy.rs
