aws_sdk_s3/operation/
list_object_versions.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListObjectVersions`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListObjectVersions;
6impl ListObjectVersions {
7    /// Creates a new `ListObjectVersions`
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::list_object_versions::ListObjectVersionsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_object_versions::ListObjectVersionsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_object_versions::ListObjectVersionsError,
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::list_object_versions::ListObjectVersionsError>()
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::list_object_versions::ListObjectVersionsOutput>()
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::list_object_versions::ListObjectVersionsInput,
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", "ListObjectVersions", 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 ListObjectVersions {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListObjectVersions");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            ListObjectVersionsRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            ListObjectVersionsResponseDeserializer,
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::Metadata::new("ListObjectVersions", "s3"));
100        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
101        signing_options.double_uri_encode = false;
102        signing_options.content_sha256_header = true;
103        signing_options.normalize_uri_path = false;
104        signing_options.payload_override = None;
105
106        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
107            signing_options,
108            ..::std::default::Default::default()
109        });
110
111        ::std::option::Option::Some(cfg.freeze())
112    }
113
114    fn runtime_components(
115        &self,
116        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
117    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
118        #[allow(unused_mut)]
119        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListObjectVersions")
120            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
121            .with_interceptor(ListObjectVersionsEndpointParamsInterceptor)
122            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
123                crate::operation::list_object_versions::ListObjectVersionsError,
124            >::new())
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
126                crate::operation::list_object_versions::ListObjectVersionsError,
127            >::new())
128            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
129                crate::operation::list_object_versions::ListObjectVersionsError,
130            >::new());
131
132        ::std::borrow::Cow::Owned(rcb)
133    }
134}
135
136#[derive(Debug)]
137struct ListObjectVersionsResponseDeserializer;
138impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListObjectVersionsResponseDeserializer {
139    fn deserialize_nonstreaming(
140        &self,
141        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
142    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
143        let (success, status) = (response.status().is_success(), response.status().as_u16());
144        let headers = response.headers();
145        let body = response.body().bytes().expect("body loaded");
146        #[allow(unused_mut)]
147        let mut force_error = false;
148        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
149        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
150            force_error = true;
151        }
152        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
153        let parse_result = if !success && status != 200 || force_error {
154            crate::protocol_serde::shape_list_object_versions::de_list_object_versions_http_error(status, headers, body)
155        } else {
156            crate::protocol_serde::shape_list_object_versions::de_list_object_versions_http_response(status, headers, body)
157        };
158        crate::protocol_serde::type_erase_result(parse_result)
159    }
160}
161#[derive(Debug)]
162struct ListObjectVersionsRequestSerializer;
163impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListObjectVersionsRequestSerializer {
164    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
165    fn serialize_input(
166        &self,
167        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
168        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
169    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
170        let input = input
171            .downcast::<crate::operation::list_object_versions::ListObjectVersionsInput>()
172            .expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            fn uri_base(
179                _input: &crate::operation::list_object_versions::ListObjectVersionsInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                ::std::write!(output, "/").expect("formatting should succeed");
184                ::std::result::Result::Ok(())
185            }
186            fn uri_query(
187                _input: &crate::operation::list_object_versions::ListObjectVersionsInput,
188                mut output: &mut ::std::string::String,
189            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
190                let mut query = ::aws_smithy_http::query::Writer::new(output);
191                query.push_v("versions");
192                if let ::std::option::Option::Some(inner_1) = &_input.delimiter {
193                    {
194                        query.push_kv("delimiter", &::aws_smithy_http::query::fmt_string(inner_1));
195                    }
196                }
197                if let ::std::option::Option::Some(inner_2) = &_input.encoding_type {
198                    {
199                        query.push_kv("encoding-type", &::aws_smithy_http::query::fmt_string(inner_2));
200                    }
201                }
202                if let ::std::option::Option::Some(inner_3) = &_input.key_marker {
203                    {
204                        query.push_kv("key-marker", &::aws_smithy_http::query::fmt_string(inner_3));
205                    }
206                }
207                if let ::std::option::Option::Some(inner_4) = &_input.max_keys {
208                    {
209                        query.push_kv("max-keys", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
210                    }
211                }
212                if let ::std::option::Option::Some(inner_5) = &_input.prefix {
213                    {
214                        query.push_kv("prefix", &::aws_smithy_http::query::fmt_string(inner_5));
215                    }
216                }
217                if let ::std::option::Option::Some(inner_6) = &_input.version_id_marker {
218                    {
219                        query.push_kv("version-id-marker", &::aws_smithy_http::query::fmt_string(inner_6));
220                    }
221                }
222                ::std::result::Result::Ok(())
223            }
224            #[allow(clippy::unnecessary_wraps)]
225            fn update_http_builder(
226                input: &crate::operation::list_object_versions::ListObjectVersionsInput,
227                builder: ::http::request::Builder,
228            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
229                let mut uri = ::std::string::String::new();
230                uri_base(input, &mut uri)?;
231                uri_query(input, &mut uri)?;
232                let builder = crate::protocol_serde::shape_list_object_versions::ser_list_object_versions_headers(input, builder)?;
233                ::std::result::Result::Ok(builder.method("GET").uri(uri))
234            }
235            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
236            builder
237        };
238        let body = ::aws_smithy_types::body::SdkBody::from("");
239
240        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
241    }
242}
243#[derive(Debug)]
244struct ListObjectVersionsEndpointParamsInterceptor;
245
246impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListObjectVersionsEndpointParamsInterceptor {
247    fn name(&self) -> &'static str {
248        "ListObjectVersionsEndpointParamsInterceptor"
249    }
250
251    fn read_before_execution(
252        &self,
253        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
254            '_,
255            ::aws_smithy_runtime_api::client::interceptors::context::Input,
256            ::aws_smithy_runtime_api::client::interceptors::context::Output,
257            ::aws_smithy_runtime_api::client::interceptors::context::Error,
258        >,
259        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
260    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
261        let _input = context
262            .input()
263            .downcast_ref::<ListObjectVersionsInput>()
264            .ok_or("failed to downcast to ListObjectVersionsInput")?;
265
266        let params = crate::config::endpoint::Params::builder()
267            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
268            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
269            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
270            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
271            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
272            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
273            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
274            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
275            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
276            .set_bucket(Some(
277                _input
278                    .bucket
279                    .clone()
280                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
281                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("bucket", "A required field was not set"))?,
282            ))
283            .set_prefix(_input.prefix.clone())
284            .build()
285            .map_err(|err| {
286                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
287            })?;
288        cfg.interceptor_state()
289            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
290        ::std::result::Result::Ok(())
291    }
292}
293
294/// Error type for the `ListObjectVersionsError` operation.
295#[non_exhaustive]
296#[derive(::std::fmt::Debug)]
297pub enum ListObjectVersionsError {
298    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
299    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
300    variable wildcard pattern and check `.code()`:
301     \
302    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
303     \
304    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListObjectVersionsError) for what information is available for the error.")]
305    Unhandled(crate::error::sealed_unhandled::Unhandled),
306}
307impl ListObjectVersionsError {
308    /// Creates the `ListObjectVersionsError::Unhandled` variant from any error type.
309    pub fn unhandled(
310        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
311    ) -> Self {
312        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
313            source: err.into(),
314            meta: ::std::default::Default::default(),
315        })
316    }
317
318    /// Creates the `ListObjectVersionsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
319    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
320        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
321            source: err.clone().into(),
322            meta: err,
323        })
324    }
325    ///
326    /// Returns error metadata, which includes the error code, message,
327    /// request ID, and potentially additional information.
328    ///
329    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
330        match self {
331            Self::Unhandled(e) => &e.meta,
332        }
333    }
334}
335impl ::std::error::Error for ListObjectVersionsError {
336    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
337        match self {
338            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
339        }
340    }
341}
342impl ::std::fmt::Display for ListObjectVersionsError {
343    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
344        match self {
345            Self::Unhandled(_inner) => {
346                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
347                    write!(f, "unhandled error ({code})")
348                } else {
349                    f.write_str("unhandled error")
350                }
351            }
352        }
353    }
354}
355impl ::aws_smithy_types::retry::ProvideErrorKind for ListObjectVersionsError {
356    fn code(&self) -> ::std::option::Option<&str> {
357        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
358    }
359    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
360        ::std::option::Option::None
361    }
362}
363impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListObjectVersionsError {
364    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
365        match self {
366            Self::Unhandled(_inner) => &_inner.meta,
367        }
368    }
369}
370impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListObjectVersionsError {
371    fn create_unhandled_error(
372        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
373        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
374    ) -> Self {
375        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
376            source,
377            meta: meta.unwrap_or_default(),
378        })
379    }
380}
381impl crate::s3_request_id::RequestIdExt for crate::operation::list_object_versions::ListObjectVersionsError {
382    fn extended_request_id(&self) -> Option<&str> {
383        self.meta().extended_request_id()
384    }
385}
386impl ::aws_types::request_id::RequestId for crate::operation::list_object_versions::ListObjectVersionsError {
387    fn request_id(&self) -> Option<&str> {
388        self.meta().request_id()
389    }
390}
391
392pub use crate::operation::list_object_versions::_list_object_versions_output::ListObjectVersionsOutput;
393
394pub use crate::operation::list_object_versions::_list_object_versions_input::ListObjectVersionsInput;
395
396mod _list_object_versions_input;
397
398mod _list_object_versions_output;
399
400/// Builders
401pub mod builders;
aws_sdk_s3/operation/list_object_versions.rs

aws_sdk_s3/operation/
list_object_versions.rs
