aws_sdk_s3/operation/
copy_object.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `CopyObject`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CopyObject;
6impl CopyObject {
7    /// Creates a new `CopyObject`
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::copy_object::CopyObjectInput,
14    ) -> ::std::result::Result<
15        crate::operation::copy_object::CopyObjectOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::copy_object::CopyObjectError,
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::copy_object::CopyObjectError>()
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::copy_object::CopyObjectOutput>()
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::copy_object::CopyObjectInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("s3", "CopyObject", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64            #[cfg(feature = "sigv4a")]
65            {
66                ::aws_runtime::auth::sigv4a::SCHEME_ID
67            },
68            crate::s3_express::auth::SCHEME_ID,
69            ::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID,
70        ]));
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for CopyObject {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CopyObject");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            CopyObjectRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            CopyObjectResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
100        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("CopyObject", "s3"));
101        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
102        signing_options.double_uri_encode = false;
103        signing_options.content_sha256_header = true;
104        signing_options.normalize_uri_path = false;
105        signing_options.payload_override = None;
106
107        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
108            signing_options,
109            ..::std::default::Default::default()
110        });
111
112        ::std::option::Option::Some(cfg.freeze())
113    }
114
115    fn runtime_components(
116        &self,
117        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
118    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
119        #[allow(unused_mut)]
120        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("CopyObject")
121            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
122            .with_interceptor(CopyObjectEndpointParamsInterceptor)
123            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
124                crate::operation::copy_object::CopyObjectError,
125            >::new())
126            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
127                crate::operation::copy_object::CopyObjectError,
128            >::new())
129            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
130                crate::operation::copy_object::CopyObjectError,
131            >::new());
132
133        ::std::borrow::Cow::Owned(rcb)
134    }
135}
136
137#[derive(Debug)]
138struct CopyObjectResponseDeserializer;
139impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CopyObjectResponseDeserializer {
140    fn deserialize_nonstreaming(
141        &self,
142        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
143    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
144        let (success, status) = (response.status().is_success(), response.status().as_u16());
145        let headers = response.headers();
146        let body = response.body().bytes().expect("body loaded");
147        #[allow(unused_mut)]
148        let mut force_error = false;
149        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
150        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
151            force_error = true;
152        }
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154        let parse_result = if !success && status != 200 || force_error {
155            crate::protocol_serde::shape_copy_object::de_copy_object_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_copy_object::de_copy_object_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct CopyObjectRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CopyObjectRequestSerializer {
165    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
166    fn serialize_input(
167        &self,
168        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
169        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
171        let input = input.downcast::<crate::operation::copy_object::CopyObjectInput>().expect("correct type");
172        let _header_serialization_settings = _cfg
173            .load::<crate::serialization_settings::HeaderSerializationSettings>()
174            .cloned()
175            .unwrap_or_default();
176        let mut request_builder = {
177            fn uri_base(
178                _input: &crate::operation::copy_object::CopyObjectInput,
179                output: &mut ::std::string::String,
180            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
181                use ::std::fmt::Write as _;
182                let input_1 = &_input.key;
183                let input_1 = input_1
184                    .as_ref()
185                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
186                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
187                if key.is_empty() {
188                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
189                        "key",
190                        "cannot be empty or unset",
191                    ));
192                }
193                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            fn uri_query(
197                _input: &crate::operation::copy_object::CopyObjectInput,
198                mut output: &mut ::std::string::String,
199            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
200                let mut query = ::aws_smithy_http::query::Writer::new(output);
201                query.push_kv("x-id", "CopyObject");
202                ::std::result::Result::Ok(())
203            }
204            #[allow(clippy::unnecessary_wraps)]
205            fn update_http_builder(
206                input: &crate::operation::copy_object::CopyObjectInput,
207                builder: ::http::request::Builder,
208            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
209                let mut uri = ::std::string::String::new();
210                uri_base(input, &mut uri)?;
211                uri_query(input, &mut uri)?;
212                let builder = crate::protocol_serde::shape_copy_object::ser_copy_object_headers(input, builder)?;
213                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
214            }
215            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
216            builder
217        };
218        let body = ::aws_smithy_types::body::SdkBody::from("");
219
220        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
221    }
222}
223#[derive(Debug)]
224struct CopyObjectEndpointParamsInterceptor;
225
226impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CopyObjectEndpointParamsInterceptor {
227    fn name(&self) -> &'static str {
228        "CopyObjectEndpointParamsInterceptor"
229    }
230
231    fn read_before_execution(
232        &self,
233        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
234            '_,
235            ::aws_smithy_runtime_api::client::interceptors::context::Input,
236            ::aws_smithy_runtime_api::client::interceptors::context::Output,
237            ::aws_smithy_runtime_api::client::interceptors::context::Error,
238        >,
239        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
240    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
241        let _input = context
242            .input()
243            .downcast_ref::<CopyObjectInput>()
244            .ok_or("failed to downcast to CopyObjectInput")?;
245
246        let params = crate::config::endpoint::Params::builder()
247            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
248            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
249            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
250            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
251            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
252            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
253            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
254            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
255            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
256            .set_disable_s3_express_session_auth(Some(true))
257            .set_bucket(Some(
258                _input
259                    .bucket
260                    .clone()
261                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
262                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
263            ))
264            .build()
265            .map_err(|err| {
266                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
267            })?;
268        cfg.interceptor_state()
269            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
270        ::std::result::Result::Ok(())
271    }
272}
273
274/// Error type for the `CopyObjectError` operation.
275#[non_exhaustive]
276#[derive(::std::fmt::Debug)]
277pub enum CopyObjectError {
278    /// <p>The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.</p>
279    ObjectNotInActiveTierError(crate::types::error::ObjectNotInActiveTierError),
280    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
281    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
282    variable wildcard pattern and check `.code()`:
283     \
284    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
285     \
286    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CopyObjectError) for what information is available for the error.")]
287    Unhandled(crate::error::sealed_unhandled::Unhandled),
288}
289impl CopyObjectError {
290    /// Creates the `CopyObjectError::Unhandled` variant from any error type.
291    pub fn unhandled(
292        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
293    ) -> Self {
294        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
295            source: err.into(),
296            meta: ::std::default::Default::default(),
297        })
298    }
299
300    /// Creates the `CopyObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
301    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
302        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
303            source: err.clone().into(),
304            meta: err,
305        })
306    }
307    ///
308    /// Returns error metadata, which includes the error code, message,
309    /// request ID, and potentially additional information.
310    ///
311    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
312        match self {
313            Self::ObjectNotInActiveTierError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::Unhandled(e) => &e.meta,
315        }
316    }
317    /// Returns `true` if the error kind is `CopyObjectError::ObjectNotInActiveTierError`.
318    pub fn is_object_not_in_active_tier_error(&self) -> bool {
319        matches!(self, Self::ObjectNotInActiveTierError(_))
320    }
321}
322impl ::std::error::Error for CopyObjectError {
323    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
324        match self {
325            Self::ObjectNotInActiveTierError(_inner) => ::std::option::Option::Some(_inner),
326            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
327        }
328    }
329}
330impl ::std::fmt::Display for CopyObjectError {
331    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
332        match self {
333            Self::ObjectNotInActiveTierError(_inner) => _inner.fmt(f),
334            Self::Unhandled(_inner) => {
335                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
336                    write!(f, "unhandled error ({code})")
337                } else {
338                    f.write_str("unhandled error")
339                }
340            }
341        }
342    }
343}
344impl ::aws_smithy_types::retry::ProvideErrorKind for CopyObjectError {
345    fn code(&self) -> ::std::option::Option<&str> {
346        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
347    }
348    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
349        ::std::option::Option::None
350    }
351}
352impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CopyObjectError {
353    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
354        match self {
355            Self::ObjectNotInActiveTierError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
356            Self::Unhandled(_inner) => &_inner.meta,
357        }
358    }
359}
360impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CopyObjectError {
361    fn create_unhandled_error(
362        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
363        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
364    ) -> Self {
365        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
366            source,
367            meta: meta.unwrap_or_default(),
368        })
369    }
370}
371impl crate::s3_request_id::RequestIdExt for crate::operation::copy_object::CopyObjectError {
372    fn extended_request_id(&self) -> Option<&str> {
373        self.meta().extended_request_id()
374    }
375}
376impl ::aws_types::request_id::RequestId for crate::operation::copy_object::CopyObjectError {
377    fn request_id(&self) -> Option<&str> {
378        self.meta().request_id()
379    }
380}
381
382pub use crate::operation::copy_object::_copy_object_output::CopyObjectOutput;
383
384pub use crate::operation::copy_object::_copy_object_input::CopyObjectInput;
385
386mod _copy_object_input;
387
388mod _copy_object_output;
389
390/// Builders
391pub mod builders;
aws_sdk_s3/operation/copy_object.rs

aws_sdk_s3/operation/
copy_object.rs
