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

aws_sdk_s3/operation/
head_bucket.rs
