aws_sdk_s3/operation/
head_bucket.rs

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

aws_sdk_s3/operation/
head_bucket.rs
