aws_sdk_s3/operation/
upload_part.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `UploadPart`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct UploadPart;
6impl UploadPart {
7    /// Creates a new `UploadPart`
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::upload_part::UploadPartInput,
14    ) -> ::std::result::Result<
15        crate::operation::upload_part::UploadPartOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::upload_part::UploadPartError,
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::upload_part::UploadPartError>()
27                    .expect("correct error type")
28            })
29        };
30        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "s3.UploadPart",
36                "rpc.service" = "s3",
37                "rpc.method" = "UploadPart",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::upload_part::UploadPartOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::upload_part::UploadPartInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "UploadPart", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74            #[cfg(feature = "sigv4a")]
75            {
76                ::aws_runtime::auth::sigv4a::SCHEME_ID
77            },
78            crate::s3_express::auth::SCHEME_ID,
79            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
80        ]));
81        if let ::std::option::Option::Some(config_override) = config_override {
82            for plugin in config_override.runtime_plugins.iter().cloned() {
83                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
84            }
85            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
86                config_override,
87                client_config.config.clone(),
88                &client_config.runtime_components,
89            ));
90        }
91        runtime_plugins
92    }
93}
94impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for UploadPart {
95    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("UploadPart");
97
98        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99            UploadPartRequestSerializer,
100        ));
101        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102            UploadPartResponseDeserializer,
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
107        ));
108
109        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
110        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("UploadPart", "s3"));
111        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
112        signing_options.double_uri_encode = false;
113        signing_options.content_sha256_header = true;
114        signing_options.normalize_uri_path = false;
115        signing_options.payload_override = None;
116
117        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
118            signing_options,
119            ..::std::default::Default::default()
120        });
121
122        ::std::option::Option::Some(cfg.freeze())
123    }
124
125    fn runtime_components(
126        &self,
127        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
128    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
129        #[allow(unused_mut)]
130        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("UploadPart")
131            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
132            .with_interceptor(UploadPartEndpointParamsInterceptor)
133            .with_interceptor(crate::http_request_checksum::RequestChecksumInterceptor::new(
134                |input: &::aws_smithy_runtime_api::client::interceptors::context::Input| {
135                    let input: &crate::operation::upload_part::UploadPartInput = input.downcast_ref().expect("correct type");
136                    let checksum_algorithm = input.checksum_algorithm();
137                    let checksum_algorithm = checksum_algorithm.map(|algorithm| algorithm.as_str());
138                    (checksum_algorithm.map(|s| s.to_string()), false)
139                },
140                |request: &mut ::aws_smithy_runtime_api::http::Request, cfg: &::aws_smithy_types::config_bag::ConfigBag| {
141                    // We check if the user has set any of the checksum values manually
142                    let mut user_set_checksum_value = false;
143                    let headers_to_check =
144                        request
145                            .headers()
146                            .iter()
147                            .filter_map(|(name, _val)| if name.starts_with("x-amz-checksum-") { Some(name) } else { None });
148                    for algo_header in headers_to_check {
149                        if request.headers().get(algo_header).is_some() {
150                            user_set_checksum_value = true;
151                        }
152                    }
153
154                    // We check if the user set the checksum algo manually
155                    let user_set_checksum_algo = request.headers().get("x-amz-sdk-checksum-algorithm").is_some();
156
157                    // This value is set by the user on the SdkConfig to indicate their preference
158                    let request_checksum_calculation = cfg
159                        .load::<::aws_smithy_types::checksum_config::RequestChecksumCalculation>()
160                        .unwrap_or(&::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported);
161
162                    // From the httpChecksum trait
163                    let http_checksum_required = false;
164
165                    let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
166
167                    // If the request is presigned we do not set a default.
168                    // If the RequestChecksumCalculation is WhenSupported and the user has not set a checksum value or algo
169                    // we default to Crc32. If it is WhenRequired and a checksum is required by the trait and the user has not
170                    // set a checksum value or algo we also set the default. In all other cases we do nothing.
171                    match (
172                        request_checksum_calculation,
173                        http_checksum_required,
174                        user_set_checksum_value,
175                        user_set_checksum_algo,
176                        is_presigned_req,
177                    ) {
178                        (_, _, _, _, true) => {}
179                        (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenSupported, _, false, false, _)
180                        | (::aws_smithy_types::checksum_config::RequestChecksumCalculation::WhenRequired, true, false, false, _) => {
181                            request.headers_mut().insert("x-amz-sdk-checksum-algorithm", "CRC32");
182                        }
183                        _ => {}
184                    }
185
186                    // We return a bool indicating if the user did set the checksum value, if they did
187                    // we can short circuit and exit the interceptor early.
188                    Ok(user_set_checksum_value)
189                },
190            ))
191            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
192                crate::operation::upload_part::UploadPartError,
193            >::new())
194            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
195                crate::operation::upload_part::UploadPartError,
196            >::new())
197            .with_retry_classifier(
198                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::upload_part::UploadPartError>::builder()
199                    .transient_errors({
200                        let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
201                        transient_errors.push("InternalError");
202                        ::std::borrow::Cow::Owned(transient_errors)
203                    })
204                    .build(),
205            );
206
207        ::std::borrow::Cow::Owned(rcb)
208    }
209}
210
211#[derive(Debug)]
212struct UploadPartResponseDeserializer;
213impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for UploadPartResponseDeserializer {
214    fn deserialize_nonstreaming(
215        &self,
216        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
217    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
218        let (success, status) = (response.status().is_success(), response.status().as_u16());
219        let headers = response.headers();
220        let body = response.body().bytes().expect("body loaded");
221        #[allow(unused_mut)]
222        let mut force_error = false;
223        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
224        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
225            force_error = true;
226        }
227        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
228        let parse_result = if !success && status != 200 || force_error {
229            crate::protocol_serde::shape_upload_part::de_upload_part_http_error(status, headers, body)
230        } else {
231            crate::protocol_serde::shape_upload_part::de_upload_part_http_response(status, headers, body)
232        };
233        crate::protocol_serde::type_erase_result(parse_result)
234    }
235}
236#[derive(Debug)]
237struct UploadPartRequestSerializer;
238impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for UploadPartRequestSerializer {
239    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
240    fn serialize_input(
241        &self,
242        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
243        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
244    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
245        let input = input.downcast::<crate::operation::upload_part::UploadPartInput>().expect("correct type");
246        let _header_serialization_settings = _cfg
247            .load::<crate::serialization_settings::HeaderSerializationSettings>()
248            .cloned()
249            .unwrap_or_default();
250        let mut request_builder = {
251            fn uri_base(
252                _input: &crate::operation::upload_part::UploadPartInput,
253                output: &mut ::std::string::String,
254            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
255                use ::std::fmt::Write as _;
256                let input_1 = &_input.key;
257                let input_1 = input_1
258                    .as_ref()
259                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
260                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
261                if key.is_empty() {
262                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
263                        "key",
264                        "cannot be empty or unset",
265                    ));
266                }
267                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
268                ::std::result::Result::Ok(())
269            }
270            fn uri_query(
271                _input: &crate::operation::upload_part::UploadPartInput,
272                mut output: &mut ::std::string::String,
273            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
274                let mut query = ::aws_smithy_http::query::Writer::new(output);
275                query.push_kv("x-id", "UploadPart");
276                let inner_2 = &_input.part_number;
277                let inner_2 = inner_2
278                    .as_ref()
279                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("part_number", "cannot be empty or unset"))?;
280                query.push_kv("partNumber", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
281                let inner_3 = &_input.upload_id;
282                let inner_3 = inner_3
283                    .as_ref()
284                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("upload_id", "cannot be empty or unset"))?;
285                if inner_3.is_empty() {
286                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
287                        "upload_id",
288                        "cannot be empty or unset",
289                    ));
290                }
291                query.push_kv("uploadId", &::aws_smithy_http::query::fmt_string(inner_3));
292                ::std::result::Result::Ok(())
293            }
294            #[allow(clippy::unnecessary_wraps)]
295            fn update_http_builder(
296                input: &crate::operation::upload_part::UploadPartInput,
297                builder: ::http::request::Builder,
298            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
299                let mut uri = ::std::string::String::new();
300                uri_base(input, &mut uri)?;
301                uri_query(input, &mut uri)?;
302                let builder = crate::protocol_serde::shape_upload_part::ser_upload_part_headers(input, builder)?;
303                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
304            }
305            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
306            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/octet-stream");
307            builder
308        };
309        let body = crate::protocol_serde::shape_upload_part_input::ser_body_http_payload(input.body)?.into_inner();
310        if let Some(content_length) = body.content_length() {
311            let content_length = content_length.to_string();
312            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
313        }
314        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
315    }
316}
317#[derive(Debug)]
318struct UploadPartEndpointParamsInterceptor;
319
320impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UploadPartEndpointParamsInterceptor {
321    fn name(&self) -> &'static str {
322        "UploadPartEndpointParamsInterceptor"
323    }
324
325    fn read_before_execution(
326        &self,
327        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
328            '_,
329            ::aws_smithy_runtime_api::client::interceptors::context::Input,
330            ::aws_smithy_runtime_api::client::interceptors::context::Output,
331            ::aws_smithy_runtime_api::client::interceptors::context::Error,
332        >,
333        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
334    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
335        let _input = context
336            .input()
337            .downcast_ref::<UploadPartInput>()
338            .ok_or("failed to downcast to UploadPartInput")?;
339
340        let params = crate::config::endpoint::Params::builder()
341            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
342            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
343            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
344            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
345            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
346            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
347            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
348            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
349            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
350            .set_bucket(Some(
351                _input
352                    .bucket
353                    .clone()
354                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
355                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
356            ))
357            .set_key(Some(
358                _input
359                    .key
360                    .clone()
361                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
362                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "A required field was not set"))?,
363            ))
364            .build()
365            .map_err(|err| {
366                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
367            })?;
368        cfg.interceptor_state()
369            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
370        ::std::result::Result::Ok(())
371    }
372}
373
374// The get_* functions below are generated from JMESPath expressions in the
375// operationContextParams trait. They target the operation's input shape.
376
377/// Error type for the `UploadPartError` operation.
378#[non_exhaustive]
379#[derive(::std::fmt::Debug)]
380pub enum UploadPartError {
381    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
382    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
383    variable wildcard pattern and check `.code()`:
384     \
385    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
386     \
387    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-UploadPartError) for what information is available for the error.")]
388    Unhandled(crate::error::sealed_unhandled::Unhandled),
389}
390impl UploadPartError {
391    /// Creates the `UploadPartError::Unhandled` variant from any error type.
392    pub fn unhandled(
393        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
394    ) -> Self {
395        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
396            source: err.into(),
397            meta: ::std::default::Default::default(),
398        })
399    }
400
401    /// Creates the `UploadPartError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
402    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
403        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
404            source: err.clone().into(),
405            meta: err,
406        })
407    }
408    ///
409    /// Returns error metadata, which includes the error code, message,
410    /// request ID, and potentially additional information.
411    ///
412    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
413        match self {
414            Self::Unhandled(e) => &e.meta,
415        }
416    }
417}
418impl ::std::error::Error for UploadPartError {
419    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
420        match self {
421            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
422        }
423    }
424}
425impl ::std::fmt::Display for UploadPartError {
426    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
427        match self {
428            Self::Unhandled(_inner) => {
429                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
430                    write!(f, "unhandled error ({code})")
431                } else {
432                    f.write_str("unhandled error")
433                }
434            }
435        }
436    }
437}
438impl ::aws_smithy_types::retry::ProvideErrorKind for UploadPartError {
439    fn code(&self) -> ::std::option::Option<&str> {
440        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
441    }
442    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
443        ::std::option::Option::None
444    }
445}
446impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for UploadPartError {
447    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
448        match self {
449            Self::Unhandled(_inner) => &_inner.meta,
450        }
451    }
452}
453impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for UploadPartError {
454    fn create_unhandled_error(
455        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
456        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
457    ) -> Self {
458        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
459            source,
460            meta: meta.unwrap_or_default(),
461        })
462    }
463}
464impl crate::s3_request_id::RequestIdExt for crate::operation::upload_part::UploadPartError {
465    fn extended_request_id(&self) -> Option<&str> {
466        self.meta().extended_request_id()
467    }
468}
469impl ::aws_types::request_id::RequestId for crate::operation::upload_part::UploadPartError {
470    fn request_id(&self) -> Option<&str> {
471        self.meta().request_id()
472    }
473}
474
475pub use crate::operation::upload_part::_upload_part_output::UploadPartOutput;
476
477pub use crate::operation::upload_part::_upload_part_input::UploadPartInput;
478
479mod _upload_part_input;
480
481mod _upload_part_output;
482
483/// Builders
484pub mod builders;