aws_sdk_s3/operation/
head_bucket.rs

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

aws_sdk_s3/operation/
head_bucket.rs
