aws_sdk_s3/operation/
delete_objects.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DeleteObjects`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DeleteObjects;
6impl DeleteObjects {
7    /// Creates a new `DeleteObjects`
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::delete_objects::DeleteObjectsInput,
14    ) -> ::std::result::Result<
15        crate::operation::delete_objects::DeleteObjectsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::delete_objects::DeleteObjectsError,
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::delete_objects::DeleteObjectsError>()
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::delete_objects::DeleteObjectsOutput>()
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::delete_objects::DeleteObjectsInput,
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", "DeleteObjects", 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 DeleteObjects {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DeleteObjects");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            DeleteObjectsRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            DeleteObjectsResponseDeserializer,
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("DeleteObjects", "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        cfg.store_put(crate::s3_express::checksum::provide_default_checksum_algorithm());
111
112        ::std::option::Option::Some(cfg.freeze())
113    }
114
115    fn runtime_components(
116        &self,
117        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
118    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
119        #[allow(unused_mut)]
120        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DeleteObjects")
121            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
122            .with_interceptor(DeleteObjectsEndpointParamsInterceptor)
123            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
124                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
125                    let input: &crate::operation::delete_objects::DeleteObjectsInput = input.downcast_ref().expect("correct type");
126                    let checksum_algorithm = input.checksum_algorithm();
127                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
128                    (checksum_algorithm.map(|s| s.to_string()), true)
129                },
130                |request: &mut ::aws_smithy_runtime_api::http::Request, cfg: &::aws_smithy_types::config_bag::ConfigBag| {
131                    // We check if the user has set any of the checksum values manually
132                    let mut user_set_checksum_value = false;
133                    let headers_to_check =
134                        request
135                            .headers()
136                            .iter()
137                            .filter_map(|(name, _val)| if name.starts_with("x-amz-checksum-") { Some(name) } else { None });
138                    for algo_header in headers_to_check {
139                        if request.headers().get(algo_header).is_some() {
140                            user_set_checksum_value = true;
141                        }
142                    }
143
144                    // We check if the user set the checksum algo manually
145                    let user_set_checksum_algo = request.headers().get("x-amz-sdk-checksum-algorithm").is_some();
146
147                    // This value is set by the user on the SdkConfig to indicate their preference
148                    let request_checksum_calculation = cfg
149                        .load::<::aws_smithy_types::checksum_config::RequestChecksumCalculation>()
150                        .unwrap_or(&::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported);
151
152                    // From the httpChecksum trait
153                    let http_checksum_required = true;
154
155                    let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
156
157                    // If the request is presigned we do not set a default.
158                    // If the RequestChecksumCalculation is WhenSupported and the user has not set a checksum value or algo
159                    // we default to Crc32. If it is WhenRequired and a checksum is required by the trait and the user has not
160                    // set a checksum value or algo we also set the default. In all other cases we do nothing.
161                    match (
162                        request_checksum_calculation,
163                        http_checksum_required,
164                        user_set_checksum_value,
165                        user_set_checksum_algo,
166                        is_presigned_req,
167                    ) {
168                        (_, _, _, _, true) => {}
169                        (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported, _, false, false, _)
170                        | (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenRequired, true, false, false, _) => {
171                            request.headers_mut().insert("x-amz-sdk-checksum-algorithm", "CRC32");
172                        }
173                        _ => {}
174                    }
175
176                    // We return a bool indicating if the user did set the checksum value, if they did
177                    // we can short circuit and exit the interceptor early.
178                    Ok(user_set_checksum_value)
179                },
180            ))
181            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
182                crate::operation::delete_objects::DeleteObjectsError,
183            >::new())
184            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
185                crate::operation::delete_objects::DeleteObjectsError,
186            >::new())
187            .with_retry_classifier(
188                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::delete_objects::DeleteObjectsError>::builder()
189                    .transient_errors({
190                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
191                        transient_errors.push("InternalError");
192                        ::std::borrow::Cow::Owned(transient_errors)
193                    })
194                    .build(),
195            );
196
197        ::std::borrow::Cow::Owned(rcb)
198    }
199}
200
201#[derive(Debug)]
202struct DeleteObjectsResponseDeserializer;
203impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteObjectsResponseDeserializer {
204    fn deserialize_nonstreaming(
205        &self,
206        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
207    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
208        let (success, status) = (response.status().is_success(), response.status().as_u16());
209        let headers = response.headers();
210        let body = response.body().bytes().expect("body loaded");
211        #[allow(unused_mut)]
212        let mut force_error = false;
213        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
214        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
215            force_error = true;
216        }
217        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
218        let parse_result = if !success && status != 200 || force_error {
219            crate::protocol_serde::shape_delete_objects::de_delete_objects_http_error(status, headers, body)
220        } else {
221            crate::protocol_serde::shape_delete_objects::de_delete_objects_http_response(status, headers, body)
222        };
223        crate::protocol_serde::type_erase_result(parse_result)
224    }
225}
226#[derive(Debug)]
227struct DeleteObjectsRequestSerializer;
228impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteObjectsRequestSerializer {
229    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
230    fn serialize_input(
231        &self,
232        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
233        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
234    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
235        let input = input
236            .downcast::<crate::operation::delete_objects::DeleteObjectsInput>()
237            .expect("correct type");
238        let _header_serialization_settings = _cfg
239            .load::<crate::serialization_settings::HeaderSerializationSettings>()
240            .cloned()
241            .unwrap_or_default();
242        let mut request_builder = {
243            fn uri_base(
244                _input: &crate::operation::delete_objects::DeleteObjectsInput,
245                output: &mut ::std::string::String,
246            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
247                use ::std::fmt::Write as _;
248                ::std::write!(output, "/").expect("formatting should succeed");
249                ::std::result::Result::Ok(())
250            }
251            fn uri_query(
252                _input: &crate::operation::delete_objects::DeleteObjectsInput,
253                mut output: &mut ::std::string::String,
254            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
255                let mut query = ::aws_smithy_http::query::Writer::new(output);
256                query.push_v("delete");
257                ::std::result::Result::Ok(())
258            }
259            #[allow(clippy::unnecessary_wraps)]
260            fn update_http_builder(
261                input: &crate::operation::delete_objects::DeleteObjectsInput,
262                builder: ::http::request::Builder,
263            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
264                let mut uri = ::std::string::String::new();
265                uri_base(input, &mut uri)?;
266                uri_query(input, &mut uri)?;
267                let builder = crate::protocol_serde::shape_delete_objects::ser_delete_objects_headers(input, builder)?;
268                ::std::result::Result::Ok(builder.method("POST").uri(uri))
269            }
270            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
271            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/xml");
272            builder
273        };
274        let body =
275            ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_delete_objects_input::ser_delete_http_payload(&input.delete)?);
276        if let Some(content_length) = body.content_length() {
277            let content_length = content_length.to_string();
278            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
279        }
280        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
281    }
282}
283#[derive(Debug)]
284struct DeleteObjectsEndpointParamsInterceptor;
285
286impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteObjectsEndpointParamsInterceptor {
287    fn name(&self) -> &'static str {
288        "DeleteObjectsEndpointParamsInterceptor"
289    }
290
291    fn read_before_execution(
292        &self,
293        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
294            '_,
295            ::aws_smithy_runtime_api::client::interceptors::context::Input,
296            ::aws_smithy_runtime_api::client::interceptors::context::Output,
297            ::aws_smithy_runtime_api::client::interceptors::context::Error,
298        >,
299        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
300    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
301        let _input = context
302            .input()
303            .downcast_ref::<DeleteObjectsInput>()
304            .ok_or("failed to downcast to DeleteObjectsInput")?;
305
306        let params = crate::config::endpoint::Params::builder()
307            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
308            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
309            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
310            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
311            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
312            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
313            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
314            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
315            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
316            .set_bucket(Some(
317                _input
318                    .bucket
319                    .clone()
320                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
321                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
322            ))
323            .build()
324            .map_err(|err| {
325                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
326            })?;
327        cfg.interceptor_state()
328            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
329        ::std::result::Result::Ok(())
330    }
331}
332
333// The get_* functions below are generated from JMESPath expressions in the
334// operationContextParams trait. They target the operation's input shape.
335
336/// Error type for the `DeleteObjectsError` operation.
337#[non_exhaustive]
338#[derive(::std::fmt::Debug)]
339pub enum DeleteObjectsError {
340    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
341    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
342    variable wildcard pattern and check `.code()`:
343     \
344    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
345     \
346    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteObjectsError) for what information is available for the error.")]
347    Unhandled(crate::error::sealed_unhandled::Unhandled),
348}
349impl DeleteObjectsError {
350    /// Creates the `DeleteObjectsError::Unhandled` variant from any error type.
351    pub fn unhandled(
352        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
353    ) -> Self {
354        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
355            source: err.into(),
356            meta: ::std::default::Default::default(),
357        })
358    }
359
360    /// Creates the `DeleteObjectsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
361    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
362        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
363            source: err.clone().into(),
364            meta: err,
365        })
366    }
367    ///
368    /// Returns error metadata, which includes the error code, message,
369    /// request ID, and potentially additional information.
370    ///
371    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
372        match self {
373            Self::Unhandled(e) => &e.meta,
374        }
375    }
376}
377impl ::std::error::Error for DeleteObjectsError {
378    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
379        match self {
380            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
381        }
382    }
383}
384impl ::std::fmt::Display for DeleteObjectsError {
385    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
386        match self {
387            Self::Unhandled(_inner) => {
388                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
389                    write!(f, "unhandled error ({code})")
390                } else {
391                    f.write_str("unhandled error")
392                }
393            }
394        }
395    }
396}
397impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteObjectsError {
398    fn code(&self) -> ::std::option::Option<&str> {
399        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
400    }
401    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
402        ::std::option::Option::None
403    }
404}
405impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteObjectsError {
406    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
407        match self {
408            Self::Unhandled(_inner) => &_inner.meta,
409        }
410    }
411}
412impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteObjectsError {
413    fn create_unhandled_error(
414        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
415        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
416    ) -> Self {
417        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
418            source,
419            meta: meta.unwrap_or_default(),
420        })
421    }
422}
423impl crate::s3_request_id::RequestIdExt for crate::operation::delete_objects::DeleteObjectsError {
424    fn extended_request_id(&self) -> Option<&str> {
425        self.meta().extended_request_id()
426    }
427}
428impl ::aws_types::request_id::RequestId for crate::operation::delete_objects::DeleteObjectsError {
429    fn request_id(&self) -> Option<&str> {
430        self.meta().request_id()
431    }
432}
433
434pub use crate::operation::delete_objects::_delete_objects_output::DeleteObjectsOutput;
435
436pub use crate::operation::delete_objects::_delete_objects_input::DeleteObjectsInput;
437
438mod _delete_objects_input;
439
440mod _delete_objects_output;
441
442/// Builders
443pub mod builders;
aws_sdk_s3/operation/delete_objects.rs

aws_sdk_s3/operation/
delete_objects.rs
