aws_sdk_s3/operation/
get_bucket_policy_status.rs

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

aws_sdk_s3/operation/
get_bucket_policy_status.rs
