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::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(DeleteObjectEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::delete_object::DeleteObjectError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::delete_object::DeleteObjectError,
133            >::new())
134            .with_retry_classifier(
135                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::delete_object::DeleteObjectError>::builder()
136                    .transient_errors({
137                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
138                        transient_errors.push("InternalError");
139                        ::std::borrow::Cow::Owned(transient_errors)
140                    })
141                    .build(),
142            );
143
144        ::std::borrow::Cow::Owned(rcb)
145    }
146}
147
148#[derive(Debug)]
149struct DeleteObjectResponseDeserializer;
150impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteObjectResponseDeserializer {
151    fn deserialize_nonstreaming(
152        &self,
153        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
154    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
155        let (success, status) = (response.status().is_success(), response.status().as_u16());
156        let headers = response.headers();
157        let body = response.body().bytes().expect("body loaded");
158        #[allow(unused_mut)]
159        let mut force_error = false;
160        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
161        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
162            force_error = true;
163        }
164        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
165        let parse_result = if !success && status != 204 || force_error {
166            crate::protocol_serde::shape_delete_object::de_delete_object_http_error(status, headers, body)
167        } else {
168            crate::protocol_serde::shape_delete_object::de_delete_object_http_response(status, headers, body)
169        };
170        crate::protocol_serde::type_erase_result(parse_result)
171    }
172}
173#[derive(Debug)]
174struct DeleteObjectRequestSerializer;
175impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteObjectRequestSerializer {
176    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
177    fn serialize_input(
178        &self,
179        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
180        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
181    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
182        let input = input
183            .downcast::<crate::operation::delete_object::DeleteObjectInput>()
184            .expect("correct type");
185        let _header_serialization_settings = _cfg
186            .load::<crate::serialization_settings::HeaderSerializationSettings>()
187            .cloned()
188            .unwrap_or_default();
189        let mut request_builder = {
190            #[allow(clippy::uninlined_format_args)]
191            fn uri_base(
192                _input: &crate::operation::delete_object::DeleteObjectInput,
193                output: &mut ::std::string::String,
194            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
195                use ::std::fmt::Write as _;
196                let input_1 = &_input.key;
197                let input_1 = input_1
198                    .as_ref()
199                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
200                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
201                if key.is_empty() {
202                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
203                        "key",
204                        "cannot be empty or unset",
205                    ));
206                }
207                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
208                ::std::result::Result::Ok(())
209            }
210            fn uri_query(
211                _input: &crate::operation::delete_object::DeleteObjectInput,
212                mut output: &mut ::std::string::String,
213            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
214                let mut query = ::aws_smithy_http::query::Writer::new(output);
215                query.push_kv("x-id", "DeleteObject");
216                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
217                    {
218                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
219                    }
220                }
221                ::std::result::Result::Ok(())
222            }
223            #[allow(clippy::unnecessary_wraps)]
224            fn update_http_builder(
225                input: &crate::operation::delete_object::DeleteObjectInput,
226                builder: ::http::request::Builder,
227            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
228                let mut uri = ::std::string::String::new();
229                uri_base(input, &mut uri)?;
230                uri_query(input, &mut uri)?;
231                let builder = crate::protocol_serde::shape_delete_object::ser_delete_object_headers(input, builder)?;
232                ::std::result::Result::Ok(builder.method("DELETE").uri(uri))
233            }
234            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
235            builder
236        };
237        let body = ::aws_smithy_types::body::SdkBody::from("");
238
239        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
240    }
241}
242#[derive(Debug)]
243struct DeleteObjectEndpointParamsInterceptor;
244
245impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteObjectEndpointParamsInterceptor {
246    fn name(&self) -> &'static str {
247        "DeleteObjectEndpointParamsInterceptor"
248    }
249
250    fn read_before_execution(
251        &self,
252        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
253            '_,
254            ::aws_smithy_runtime_api::client::interceptors::context::Input,
255            ::aws_smithy_runtime_api::client::interceptors::context::Output,
256            ::aws_smithy_runtime_api::client::interceptors::context::Error,
257        >,
258        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
259    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
260        let _input = context
261            .input()
262            .downcast_ref::<DeleteObjectInput>()
263            .ok_or("failed to downcast to DeleteObjectInput")?;
264
265        let params = crate::config::endpoint::Params::builder()
266            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
267            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
268            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
269            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
270            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
271            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
272            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
273            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
274            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
275            .set_bucket(Some(
276                _input
277                    .bucket
278                    .clone()
279                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
280                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
281            ))
282            .set_key(Some(
283                _input
284                    .key
285                    .clone()
286                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
287                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "A required field was not set"))?,
288            ))
289            .build()
290            .map_err(|err| {
291                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
292            })?;
293        cfg.interceptor_state()
294            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
295        ::std::result::Result::Ok(())
296    }
297}
298
299// The get_* functions below are generated from JMESPath expressions in the
300// operationContextParams trait. They target the operation's input shape.
301
302/// Error type for the `DeleteObjectError` operation.
303#[non_exhaustive]
304#[derive(::std::fmt::Debug)]
305pub enum DeleteObjectError {
306    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
307    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
308    variable wildcard pattern and check `.code()`:
309     \
310    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
311     \
312    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteObjectError) for what information is available for the error.")]
313    Unhandled(crate::error::sealed_unhandled::Unhandled),
314}
315impl DeleteObjectError {
316    /// Creates the `DeleteObjectError::Unhandled` variant from any error type.
317    pub fn unhandled(
318        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
319    ) -> Self {
320        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
321            source: err.into(),
322            meta: ::std::default::Default::default(),
323        })
324    }
325
326    /// Creates the `DeleteObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
327    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
328        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
329            source: err.clone().into(),
330            meta: err,
331        })
332    }
333    ///
334    /// Returns error metadata, which includes the error code, message,
335    /// request ID, and potentially additional information.
336    ///
337    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
338        match self {
339            Self::Unhandled(e) => &e.meta,
340        }
341    }
342}
343impl ::std::error::Error for DeleteObjectError {
344    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
345        match self {
346            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
347        }
348    }
349}
350impl ::std::fmt::Display for DeleteObjectError {
351    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
352        match self {
353            Self::Unhandled(_inner) => {
354                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
355                    write!(f, "unhandled error ({code})")
356                } else {
357                    f.write_str("unhandled error")
358                }
359            }
360        }
361    }
362}
363impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteObjectError {
364    fn code(&self) -> ::std::option::Option<&str> {
365        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
366    }
367    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
368        ::std::option::Option::None
369    }
370}
371impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteObjectError {
372    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
373        match self {
374            Self::Unhandled(_inner) => &_inner.meta,
375        }
376    }
377}
378impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteObjectError {
379    fn create_unhandled_error(
380        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
381        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
382    ) -> Self {
383        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
384            source,
385            meta: meta.unwrap_or_default(),
386        })
387    }
388}
389impl crate::s3_request_id::RequestIdExt for crate::operation::delete_object::DeleteObjectError {
390    fn extended_request_id(&self) -> Option<&str> {
391        self.meta().extended_request_id()
392    }
393}
394impl ::aws_types::request_id::RequestId for crate::operation::delete_object::DeleteObjectError {
395    fn request_id(&self) -> Option<&str> {
396        self.meta().request_id()
397    }
398}
399
400pub use crate::operation::delete_object::_delete_object_output::DeleteObjectOutput;
401
402pub use crate::operation::delete_object::_delete_object_input::DeleteObjectInput;
403
404mod _delete_object_input;
405
406mod _delete_object_output;
407
408/// Builders
409pub mod builders;