aws_sdk_s3/operation/
delete_object.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DeleteObject`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DeleteObject;
6impl DeleteObject {
7    /// Creates a new `DeleteObject`
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_object::DeleteObjectInput,
14    ) -> ::std::result::Result<
15        crate::operation::delete_object::DeleteObjectOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::delete_object::DeleteObjectError,
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_object::DeleteObjectError>()
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_object::DeleteObjectOutput>()
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_object::DeleteObjectInput,
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", "DeleteObject", 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.DeleteObject",
59                "rpc.service" = "S3",
60                "rpc.method" = "DeleteObject",
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 DeleteObject {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DeleteObject");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DeleteObjectRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DeleteObjectResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DeleteObject")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DeleteObject", "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("DeleteObject")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                DeleteObjectTelemetryInputCaptureInterceptor,
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                DeleteObjectEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::delete_object::DeleteObjectError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::delete_object::DeleteObjectError,
140            >::new())
141            .with_retry_classifier(
142                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::delete_object::DeleteObjectError>::builder()
143                    .transient_errors({
144                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
145                        transient_errors.push("InternalError");
146                        ::std::borrow::Cow::Owned(transient_errors)
147                    })
148                    .build(),
149            )
150            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
151                crate::operation::delete_object::DeleteObjectError,
152            >::new());
153
154        ::std::borrow::Cow::Owned(rcb)
155    }
156}
157
158#[derive(Debug)]
159struct DeleteObjectTelemetryInputCaptureInterceptor;
160
161#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
162impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteObjectTelemetryInputCaptureInterceptor {
163    fn name(&self) -> &'static str {
164        "DeleteObjectTelemetryInputCaptureInterceptor"
165    }
166
167    fn read_before_execution(
168        &self,
169        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
170            '_,
171            ::aws_smithy_runtime_api::client::interceptors::context::Input,
172            ::aws_smithy_runtime_api::client::interceptors::context::Output,
173            ::aws_smithy_runtime_api::client::interceptors::context::Error,
174        >,
175        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
176    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
177        // Nothing to do unless the customer opted in by naming members to record.
178        let ::std::option::Option::Some(requested) = cfg
179            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
180            .filter(|r| !r.is_empty())
181        else {
182            return ::std::result::Result::Ok(());
183        };
184
185        let ::std::option::Option::Some(input) = context.input().downcast_ref::<DeleteObjectInput>() else {
186            // A mismatched input is not this interceptor's concern; skip quietly.
187            return ::std::result::Result::Ok(());
188        };
189
190        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
191        if requested.should_capture("Bucket") {
192            if let ::std::option::Option::Some(value) = input.bucket.as_deref() {
193                captured.insert("Bucket", value);
194            }
195        }
196        if requested.should_capture("Key") {
197            if let ::std::option::Option::Some(value) = input.key.as_deref() {
198                captured.insert("Key", value);
199            }
200        }
201        if requested.should_capture("MFA") {
202            if let ::std::option::Option::Some(value) = input.mfa.as_deref() {
203                captured.insert("MFA", value);
204            }
205        }
206        if requested.should_capture("VersionId") {
207            if let ::std::option::Option::Some(value) = input.version_id.as_deref() {
208                captured.insert("VersionId", value);
209            }
210        }
211        if requested.should_capture("ExpectedBucketOwner") {
212            if let ::std::option::Option::Some(value) = input.expected_bucket_owner.as_deref() {
213                captured.insert("ExpectedBucketOwner", value);
214            }
215        }
216        if requested.should_capture("IfMatch") {
217            if let ::std::option::Option::Some(value) = input.if_match.as_deref() {
218                captured.insert("IfMatch", value);
219            }
220        }
221
222        cfg.interceptor_state().store_put(captured);
223        ::std::result::Result::Ok(())
224    }
225}
226#[derive(Debug)]
227struct DeleteObjectResponseDeserializer;
228impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteObjectResponseDeserializer {
229    fn deserialize_nonstreaming_with_config(
230        &self,
231        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
232        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
233    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
234        let (success, status) = (response.status().is_success(), response.status().as_u16());
235        let headers = response.headers();
236        let body = response.body().bytes().expect("body loaded");
237        #[allow(unused_mut)]
238        let mut force_error = false;
239        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
240        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
241            force_error = true;
242        }
243        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
244        let parse_result = if !success && status != 204 || force_error {
245            crate::protocol_serde::shape_delete_object::de_delete_object_http_error(status, headers, body)
246        } else {
247            crate::protocol_serde::shape_delete_object::de_delete_object_http_response(status, headers, body)
248        };
249        crate::protocol_serde::type_erase_result(parse_result)
250    }
251}
252#[derive(Debug)]
253struct DeleteObjectRequestSerializer;
254impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteObjectRequestSerializer {
255    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
256    fn serialize_input(
257        &self,
258        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
259        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
260    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
261        let input = input
262            .downcast::<crate::operation::delete_object::DeleteObjectInput>()
263            .expect("correct type");
264        let _header_serialization_settings = _cfg
265            .load::<crate::serialization_settings::HeaderSerializationSettings>()
266            .cloned()
267            .unwrap_or_default();
268        let mut request_builder = {
269            #[allow(clippy::uninlined_format_args)]
270            fn uri_base(
271                _input: &crate::operation::delete_object::DeleteObjectInput,
272                output: &mut ::std::string::String,
273            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
274                use ::std::fmt::Write as _;
275                let input_1 = &_input.key;
276                let input_1 = input_1
277                    .as_ref()
278                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
279                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
280                if key.is_empty() {
281                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
282                        "key",
283                        "cannot be empty or unset",
284                    ));
285                }
286                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
287                ::std::result::Result::Ok(())
288            }
289            fn uri_query(
290                _input: &crate::operation::delete_object::DeleteObjectInput,
291                mut output: &mut ::std::string::String,
292            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
293                let mut query = ::aws_smithy_http::query::Writer::new(output);
294                query.push_kv("x-id", "DeleteObject");
295                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
296                    {
297                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
298                    }
299                }
300                ::std::result::Result::Ok(())
301            }
302            #[allow(clippy::unnecessary_wraps)]
303            fn update_http_builder(
304                input: &crate::operation::delete_object::DeleteObjectInput,
305                builder: ::http_1x::request::Builder,
306            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
307                let mut uri = ::std::string::String::new();
308                uri_base(input, &mut uri)?;
309                uri_query(input, &mut uri)?;
310                let builder = crate::protocol_serde::shape_delete_object::ser_delete_object_headers(input, builder)?;
311                ::std::result::Result::Ok(builder.method("DELETE").uri(uri))
312            }
313            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
314            builder
315        };
316        let body = ::aws_smithy_types::body::SdkBody::from("");
317
318        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
319    }
320}
321#[derive(Debug)]
322struct DeleteObjectEndpointParamsInterceptor;
323
324#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
325impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteObjectEndpointParamsInterceptor {
326    fn name(&self) -> &'static str {
327        "DeleteObjectEndpointParamsInterceptor"
328    }
329
330    fn read_before_execution(
331        &self,
332        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
333            '_,
334            ::aws_smithy_runtime_api::client::interceptors::context::Input,
335            ::aws_smithy_runtime_api::client::interceptors::context::Output,
336            ::aws_smithy_runtime_api::client::interceptors::context::Error,
337        >,
338        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
339    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
340        let _input = context
341            .input()
342            .downcast_ref::<DeleteObjectInput>()
343            .ok_or("failed to downcast to DeleteObjectInput")?;
344
345        let params = crate::config::endpoint::Params::builder()
346            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
347            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
348            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
349            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
350            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
351            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
352            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
353            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
354            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
355            .set_bucket(Some(
356                _input
357                    .bucket
358                    .clone()
359                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
360                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
361            ))
362            .set_key(Some(
363                _input
364                    .key
365                    .clone()
366                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
367                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "A required field was not set"))?,
368            ))
369            .build()
370            .map_err(|err| {
371                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
372            })?;
373        cfg.interceptor_state()
374            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
375        ::std::result::Result::Ok(())
376    }
377}
378
379// The get_* functions below are generated from JMESPath expressions in the
380// operationContextParams trait. They target the operation's input shape.
381
382/// Error type for the `DeleteObjectError` operation.
383#[non_exhaustive]
384#[derive(::std::fmt::Debug)]
385pub enum DeleteObjectError {
386    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
387    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
388    variable wildcard pattern and check `.code()`:
389     \
390    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
391     \
392    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteObjectError) for what information is available for the error.")]
393    Unhandled(crate::error::sealed_unhandled::Unhandled),
394}
395impl DeleteObjectError {
396    /// Creates the `DeleteObjectError::Unhandled` variant from any error type.
397    pub fn unhandled(
398        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
399    ) -> Self {
400        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
401            source: err.into(),
402            meta: ::std::default::Default::default(),
403        })
404    }
405
406    /// Creates the `DeleteObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
407    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
408        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
409            source: err.clone().into(),
410            meta: err,
411        })
412    }
413    ///
414    /// Returns error metadata, which includes the error code, message,
415    /// request ID, and potentially additional information.
416    ///
417    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
418        match self {
419            Self::Unhandled(e) => &e.meta,
420        }
421    }
422}
423impl ::std::error::Error for DeleteObjectError {
424    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
425        match self {
426            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
427        }
428    }
429}
430impl ::std::fmt::Display for DeleteObjectError {
431    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
432        match self {
433            Self::Unhandled(_inner) => {
434                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
435                    write!(f, "unhandled error ({code})")
436                } else {
437                    f.write_str("unhandled error")
438                }
439            }
440        }
441    }
442}
443impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteObjectError {
444    fn code(&self) -> ::std::option::Option<&str> {
445        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
446    }
447    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
448        ::std::option::Option::None
449    }
450}
451impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteObjectError {
452    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
453        match self {
454            Self::Unhandled(_inner) => &_inner.meta,
455        }
456    }
457}
458impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteObjectError {
459    fn create_unhandled_error(
460        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
461        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
462    ) -> Self {
463        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
464            source,
465            meta: meta.unwrap_or_default(),
466        })
467    }
468}
469impl crate::s3_request_id::RequestIdExt for crate::operation::delete_object::DeleteObjectError {
470    fn extended_request_id(&self) -> Option<&str> {
471        self.meta().extended_request_id()
472    }
473}
474impl ::aws_types::request_id::RequestId for crate::operation::delete_object::DeleteObjectError {
475    fn request_id(&self) -> Option<&str> {
476        self.meta().request_id()
477    }
478}
479
480pub use crate::operation::delete_object::_delete_object_input::DeleteObjectInput;
481
482pub use crate::operation::delete_object::_delete_object_output::DeleteObjectOutput;
483
484mod _delete_object_input;
485
486mod _delete_object_output;
487
488/// Builders
489pub mod builders;
aws_sdk_s3/operation/delete_object.rs

aws_sdk_s3/operation/
delete_object.rs
