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

aws_sdk_s3/operation/
delete_object.rs
