aws_sdk_s3/operation/
list_objects_v2.rs

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

aws_sdk_s3/operation/
list_objects_v2.rs
