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

aws_sdk_s3/operation/
list_objects_v2.rs
