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

aws_sdk_s3/operation/
list_objects_v2.rs
