aws_sdk_s3/operation/
copy_object.rs

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        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("S3", "CopyObject", 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.CopyObject",
59                "rpc.service" = "S3",
60                "rpc.method" = "CopyObject",
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 CopyObject {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CopyObject");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            CopyObjectRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            CopyObjectResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("CopyObject")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("CopyObject", "S3"));
107        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
108        signing_options.double_uri_encode = false;
109        signing_options.content_sha256_header = true;
110        signing_options.normalize_uri_path = false;
111        signing_options.payload_override = None;
112
113        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
114            signing_options,
115            ..::std::default::Default::default()
116        });
117
118        ::std::option::Option::Some(cfg.freeze())
119    }
120
121    fn runtime_components(
122        &self,
123        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
124    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
125        #[allow(unused_mut)]
126        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("CopyObject")
127            .with_interceptor(CopyObjectEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::copy_object::CopyObjectError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::copy_object::CopyObjectError,
133            >::new())
134            .with_retry_classifier(
135                ::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::copy_object::CopyObjectError>::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 CopyObjectResponseDeserializer;
150impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CopyObjectResponseDeserializer {
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 != 200 || force_error {
166            crate::protocol_serde::shape_copy_object::de_copy_object_http_error(status, headers, body)
167        } else {
168            crate::protocol_serde::shape_copy_object::de_copy_object_http_response(status, headers, body)
169        };
170        crate::protocol_serde::type_erase_result(parse_result)
171    }
172}
173#[derive(Debug)]
174struct CopyObjectRequestSerializer;
175impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CopyObjectRequestSerializer {
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.downcast::<crate::operation::copy_object::CopyObjectInput>().expect("correct type");
183        let _header_serialization_settings = _cfg
184            .load::<crate::serialization_settings::HeaderSerializationSettings>()
185            .cloned()
186            .unwrap_or_default();
187        let mut request_builder = {
188            fn uri_base(
189                _input: &crate::operation::copy_object::CopyObjectInput,
190                output: &mut ::std::string::String,
191            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
192                use ::std::fmt::Write as _;
193                let input_1 = &_input.key;
194                let input_1 = input_1
195                    .as_ref()
196                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("key", "cannot be empty or unset"))?;
197                let key = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Greedy);
198                if key.is_empty() {
199                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
200                        "key",
201                        "cannot be empty or unset",
202                    ));
203                }
204                ::std::write!(output, "/{Key}", Key = key).expect("formatting should succeed");
205                ::std::result::Result::Ok(())
206            }
207            fn uri_query(
208                _input: &crate::operation::copy_object::CopyObjectInput,
209                mut output: &mut ::std::string::String,
210            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
211                let mut query = ::aws_smithy_http::query::Writer::new(output);
212                query.push_kv("x-id", "CopyObject");
213                ::std::result::Result::Ok(())
214            }
215            #[allow(clippy::unnecessary_wraps)]
216            fn update_http_builder(
217                input: &crate::operation::copy_object::CopyObjectInput,
218                builder: ::http::request::Builder,
219            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
220                let mut uri = ::std::string::String::new();
221                uri_base(input, &mut uri)?;
222                uri_query(input, &mut uri)?;
223                let builder = crate::protocol_serde::shape_copy_object::ser_copy_object_headers(input, builder)?;
224                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
225            }
226            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
227            builder
228        };
229        let body = ::aws_smithy_types::body::SdkBody::from("");
230
231        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
232    }
233}
234#[derive(Debug)]
235struct CopyObjectEndpointParamsInterceptor;
236
237impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CopyObjectEndpointParamsInterceptor {
238    fn name(&self) -> &'static str {
239        "CopyObjectEndpointParamsInterceptor"
240    }
241
242    fn read_before_execution(
243        &self,
244        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
245            '_,
246            ::aws_smithy_runtime_api::client::interceptors::context::Input,
247            ::aws_smithy_runtime_api::client::interceptors::context::Output,
248            ::aws_smithy_runtime_api::client::interceptors::context::Error,
249        >,
250        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
251    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
252        let _input = context
253            .input()
254            .downcast_ref::<CopyObjectInput>()
255            .ok_or("failed to downcast to CopyObjectInput")?;
256
257        let params = crate::config::endpoint::Params::builder()
258            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
259            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
260            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
261            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
262            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
263            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
264            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
265            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
266            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
267            .set_disable_s3_express_session_auth(Some(true))
268            .set_bucket(Some(
269                _input
270                    .bucket
271                    .clone()
272                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
273                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
274            ))
275            .set_copy_source(Some(
276                _input
277                    .copy_source
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("copy_source", "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 `CopyObjectError` operation.
303#[non_exhaustive]
304#[derive(::std::fmt::Debug)]
305pub enum CopyObjectError {
306    /// <p>The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.</p>
307    ObjectNotInActiveTierError(crate::types::error::ObjectNotInActiveTierError),
308    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
309    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
310    variable wildcard pattern and check `.code()`:
311     \
312    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
313     \
314    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CopyObjectError) for what information is available for the error.")]
315    Unhandled(crate::error::sealed_unhandled::Unhandled),
316}
317impl CopyObjectError {
318    /// Creates the `CopyObjectError::Unhandled` variant from any error type.
319    pub fn unhandled(
320        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
321    ) -> Self {
322        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
323            source: err.into(),
324            meta: ::std::default::Default::default(),
325        })
326    }
327
328    /// Creates the `CopyObjectError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
329    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
330        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
331            source: err.clone().into(),
332            meta: err,
333        })
334    }
335    ///
336    /// Returns error metadata, which includes the error code, message,
337    /// request ID, and potentially additional information.
338    ///
339    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
340        match self {
341            Self::ObjectNotInActiveTierError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
342            Self::Unhandled(e) => &e.meta,
343        }
344    }
345    /// Returns `true` if the error kind is `CopyObjectError::ObjectNotInActiveTierError`.
346    pub fn is_object_not_in_active_tier_error(&self) -> bool {
347        matches!(self, Self::ObjectNotInActiveTierError(_))
348    }
349}
350impl ::std::error::Error for CopyObjectError {
351    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
352        match self {
353            Self::ObjectNotInActiveTierError(_inner) => ::std::option::Option::Some(_inner),
354            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
355        }
356    }
357}
358impl ::std::fmt::Display for CopyObjectError {
359    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
360        match self {
361            Self::ObjectNotInActiveTierError(_inner) => _inner.fmt(f),
362            Self::Unhandled(_inner) => {
363                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
364                    write!(f, "unhandled error ({code})")
365                } else {
366                    f.write_str("unhandled error")
367                }
368            }
369        }
370    }
371}
372impl ::aws_smithy_types::retry::ProvideErrorKind for CopyObjectError {
373    fn code(&self) -> ::std::option::Option<&str> {
374        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
375    }
376    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
377        ::std::option::Option::None
378    }
379}
380impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CopyObjectError {
381    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
382        match self {
383            Self::ObjectNotInActiveTierError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::Unhandled(_inner) => &_inner.meta,
385        }
386    }
387}
388impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CopyObjectError {
389    fn create_unhandled_error(
390        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
391        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
392    ) -> Self {
393        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
394            source,
395            meta: meta.unwrap_or_default(),
396        })
397    }
398}
399impl crate::s3_request_id::RequestIdExt for crate::operation::copy_object::CopyObjectError {
400    fn extended_request_id(&self) -> Option<&str> {
401        self.meta().extended_request_id()
402    }
403}
404impl ::aws_types::request_id::RequestId for crate::operation::copy_object::CopyObjectError {
405    fn request_id(&self) -> Option<&str> {
406        self.meta().request_id()
407    }
408}
409
410pub use crate::operation::copy_object::_copy_object_output::CopyObjectOutput;
411
412pub use crate::operation::copy_object::_copy_object_input::CopyObjectInput;
413
414mod _copy_object_input;
415
416mod _copy_object_output;
417
418/// Builders
419pub mod builders;
aws_sdk_s3/operation/copy_object.rs

aws_sdk_s3/operation/
copy_object.rs
