aws_sdk_s3/operation/
create_bucket.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `CreateBucket`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CreateBucket;
6impl CreateBucket {
7    /// Creates a new `CreateBucket`
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::create_bucket::CreateBucketInput,
14    ) -> ::std::result::Result<
15        crate::operation::create_bucket::CreateBucketOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::create_bucket::CreateBucketError,
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::create_bucket::CreateBucketError>()
27                    .expect("correct error type")
28            })
29        };
30        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "s3.CreateBucket",
36                "rpc.service" = "s3",
37                "rpc.method" = "CreateBucket",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::create_bucket::CreateBucketOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::create_bucket::CreateBucketInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "CreateBucket", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74            #[cfg(feature = "sigv4a")]
75            {
76                ::aws_runtime::auth::sigv4a::SCHEME_ID
77            },
78            crate::s3_express::auth::SCHEME_ID,
79            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
80        ]));
81        if let ::std::option::Option::Some(config_override) = config_override {
82            for plugin in config_override.runtime_plugins.iter().cloned() {
83                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
84            }
85            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
86                config_override,
87                client_config.config.clone(),
88                &client_config.runtime_components,
89            ));
90        }
91        runtime_plugins
92    }
93}
94impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for CreateBucket {
95    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CreateBucket");
97
98        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99            CreateBucketRequestSerializer,
100        ));
101        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102            CreateBucketResponseDeserializer,
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("CreateBucket", "s3"));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = false;
112        signing_options.content_sha256_header = true;
113        signing_options.normalize_uri_path = false;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("CreateBucket")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(CreateBucketEndpointParamsInterceptor)
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::create_bucket::CreateBucketError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::create_bucket::CreateBucketError,
137            >::new())
138            .with_retry_classifier(
139                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::create_bucket::CreateBucketError>::builder()
140                    .transient_errors({
141                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
142                        transient_errors.push("InternalError");
143                        ::std::borrow::Cow::Owned(transient_errors)
144                    })
145                    .build(),
146            );
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct CreateBucketResponseDeserializer;
154impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CreateBucketResponseDeserializer {
155    fn deserialize_nonstreaming(
156        &self,
157        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
158    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
159        let (success, status) = (response.status().is_success(), response.status().as_u16());
160        let headers = response.headers();
161        let body = response.body().bytes().expect("body loaded");
162        #[allow(unused_mut)]
163        let mut force_error = false;
164        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
165        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
166            force_error = true;
167        }
168        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
169        let parse_result = if !success && status != 200 || force_error {
170            crate::protocol_serde::shape_create_bucket::de_create_bucket_http_error(status, headers, body)
171        } else {
172            crate::protocol_serde::shape_create_bucket::de_create_bucket_http_response(status, headers, body)
173        };
174        crate::protocol_serde::type_erase_result(parse_result)
175    }
176}
177#[derive(Debug)]
178struct CreateBucketRequestSerializer;
179impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CreateBucketRequestSerializer {
180    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
181    fn serialize_input(
182        &self,
183        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
184        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
185    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
186        let input = input
187            .downcast::<crate::operation::create_bucket::CreateBucketInput>()
188            .expect("correct type");
189        let _header_serialization_settings = _cfg
190            .load::<crate::serialization_settings::HeaderSerializationSettings>()
191            .cloned()
192            .unwrap_or_default();
193        let mut request_builder = {
194            fn uri_base(
195                _input: &crate::operation::create_bucket::CreateBucketInput,
196                output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                use ::std::fmt::Write as _;
199                ::std::write!(output, "/").expect("formatting should succeed");
200                ::std::result::Result::Ok(())
201            }
202            #[allow(clippy::unnecessary_wraps)]
203            fn update_http_builder(
204                input: &crate::operation::create_bucket::CreateBucketInput,
205                builder: ::http::request::Builder,
206            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
207                let mut uri = ::std::string::String::new();
208                uri_base(input, &mut uri)?;
209                let builder = crate::protocol_serde::shape_create_bucket::ser_create_bucket_headers(input, builder)?;
210                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
211            }
212            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
213            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
214            builder
215        };
216        let body = ::aws_smithy_types::body::SdkBody::from(
217            crate::protocol_serde::shape_create_bucket_input::ser_create_bucket_configuration_http_payload(&input.create_bucket_configuration)?,
218        );
219        if let Some(content_length) = body.content_length() {
220            let content_length = content_length.to_string();
221            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
222        }
223        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
224    }
225}
226#[derive(Debug)]
227struct CreateBucketEndpointParamsInterceptor;
228
229impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CreateBucketEndpointParamsInterceptor {
230    fn name(&self) -> &'static str {
231        "CreateBucketEndpointParamsInterceptor"
232    }
233
234    fn read_before_execution(
235        &self,
236        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
237            '_,
238            ::aws_smithy_runtime_api::client::interceptors::context::Input,
239            ::aws_smithy_runtime_api::client::interceptors::context::Output,
240            ::aws_smithy_runtime_api::client::interceptors::context::Error,
241        >,
242        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
243    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
244        let _input = context
245            .input()
246            .downcast_ref::<CreateBucketInput>()
247            .ok_or("failed to downcast to CreateBucketInput")?;
248
249        let params = crate::config::endpoint::Params::builder()
250            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
251            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
252            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
253            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
254            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
255            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
256            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
257            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
258            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
259            .set_use_s3_express_control_endpoint(Some(true))
260            .set_disable_access_points(Some(true))
261            .set_bucket(Some(
262                _input
263                    .bucket
264                    .clone()
265                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
266                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
267            ))
268            .build()
269            .map_err(|err| {
270                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
271            })?;
272        cfg.interceptor_state()
273            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
274        ::std::result::Result::Ok(())
275    }
276}
277
278// The get_* functions below are generated from JMESPath expressions in the
279// operationContextParams trait. They target the operation's input shape.
280
281/// Error type for the `CreateBucketError` operation.
282#[non_exhaustive]
283#[derive(::std::fmt::Debug)]
284pub enum CreateBucketError {
285    /// <p>The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.</p>
286    BucketAlreadyExists(crate::types::error::BucketAlreadyExists),
287    /// <p>The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).</p>
288    BucketAlreadyOwnedByYou(crate::types::error::BucketAlreadyOwnedByYou),
289    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
290    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
291    variable wildcard pattern and check `.code()`:
292     \
293    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
294     \
295    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CreateBucketError) for what information is available for the error.")]
296    Unhandled(crate::error::sealed_unhandled::Unhandled),
297}
298impl CreateBucketError {
299    /// Creates the `CreateBucketError::Unhandled` variant from any error type.
300    pub fn unhandled(
301        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
302    ) -> Self {
303        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
304            source: err.into(),
305            meta: ::std::default::Default::default(),
306        })
307    }
308
309    /// Creates the `CreateBucketError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
310    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
311        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
312            source: err.clone().into(),
313            meta: err,
314        })
315    }
316    ///
317    /// Returns error metadata, which includes the error code, message,
318    /// request ID, and potentially additional information.
319    ///
320    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
321        match self {
322            Self::BucketAlreadyExists(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::BucketAlreadyOwnedByYou(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::Unhandled(e) => &e.meta,
325        }
326    }
327    /// Returns `true` if the error kind is `CreateBucketError::BucketAlreadyExists`.
328    pub fn is_bucket_already_exists(&self) -> bool {
329        matches!(self, Self::BucketAlreadyExists(_))
330    }
331    /// Returns `true` if the error kind is `CreateBucketError::BucketAlreadyOwnedByYou`.
332    pub fn is_bucket_already_owned_by_you(&self) -> bool {
333        matches!(self, Self::BucketAlreadyOwnedByYou(_))
334    }
335}
336impl ::std::error::Error for CreateBucketError {
337    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
338        match self {
339            Self::BucketAlreadyExists(_inner) => ::std::option::Option::Some(_inner),
340            Self::BucketAlreadyOwnedByYou(_inner) => ::std::option::Option::Some(_inner),
341            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
342        }
343    }
344}
345impl ::std::fmt::Display for CreateBucketError {
346    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
347        match self {
348            Self::BucketAlreadyExists(_inner) => _inner.fmt(f),
349            Self::BucketAlreadyOwnedByYou(_inner) => _inner.fmt(f),
350            Self::Unhandled(_inner) => {
351                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
352                    write!(f, "unhandled error ({code})")
353                } else {
354                    f.write_str("unhandled error")
355                }
356            }
357        }
358    }
359}
360impl ::aws_smithy_types::retry::ProvideErrorKind for CreateBucketError {
361    fn code(&self) -> ::std::option::Option<&str> {
362        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
363    }
364    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
365        ::std::option::Option::None
366    }
367}
368impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CreateBucketError {
369    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
370        match self {
371            Self::BucketAlreadyExists(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::BucketAlreadyOwnedByYou(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::Unhandled(_inner) => &_inner.meta,
374        }
375    }
376}
377impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CreateBucketError {
378    fn create_unhandled_error(
379        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
380        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
381    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
383            source,
384            meta: meta.unwrap_or_default(),
385        })
386    }
387}
388impl crate::s3_request_id::RequestIdExt for crate::operation::create_bucket::CreateBucketError {
389    fn extended_request_id(&self) -> Option<&str> {
390        self.meta().extended_request_id()
391    }
392}
393impl ::aws_types::request_id::RequestId for crate::operation::create_bucket::CreateBucketError {
394    fn request_id(&self) -> Option<&str> {
395        self.meta().request_id()
396    }
397}
398
399pub use crate::operation::create_bucket::_create_bucket_output::CreateBucketOutput;
400
401pub use crate::operation::create_bucket::_create_bucket_input::CreateBucketInput;
402
403mod _create_bucket_input;
404
405mod _create_bucket_output;
406
407/// Builders
408pub mod builders;