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

aws_sdk_s3/operation/
list_objects_v2.rs
