aws_sdk_s3/operation/
list_directory_buckets.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListDirectoryBuckets`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListDirectoryBuckets;
6impl ListDirectoryBuckets {
7    /// Creates a new `ListDirectoryBuckets`
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_directory_buckets::ListDirectoryBucketsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_directory_buckets::ListDirectoryBucketsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_directory_buckets::ListDirectoryBucketsError,
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_directory_buckets::ListDirectoryBucketsError>()
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_directory_buckets::ListDirectoryBucketsOutput>()
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_directory_buckets::ListDirectoryBucketsInput,
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", "ListDirectoryBuckets", 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.ListDirectoryBuckets",
59                "rpc.service" = "S3",
60                "rpc.method" = "ListDirectoryBuckets",
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 ListDirectoryBuckets {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListDirectoryBuckets");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListDirectoryBucketsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListDirectoryBucketsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListDirectoryBuckets")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListDirectoryBuckets",
107            "S3",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = false;
111        signing_options.content_sha256_header = true;
112        signing_options.normalize_uri_path = false;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128                    let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListDirectoryBuckets")
129                            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(ListDirectoryBucketsTelemetryInputCaptureInterceptor))
130.with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default()))
131.with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(ListDirectoryBucketsEndpointParamsInterceptor))
132                            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<crate::operation::list_directory_buckets::ListDirectoryBucketsError>::new())
133.with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<crate::operation::list_directory_buckets::ListDirectoryBucketsError>::new())
134.with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<crate::operation::list_directory_buckets::ListDirectoryBucketsError>::builder().transient_errors({
135                                            let mut transient_errors: Vec<&'static str> = ::aws_runtime::retries::classifiers::TRANSIENT_ERRORS.into();
136                                            transient_errors.push("InternalError");
137                                            ::std::borrow::Cow::Owned(transient_errors)
138                                            }).build())
139.with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<crate::operation::list_directory_buckets::ListDirectoryBucketsError>::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct ListDirectoryBucketsTelemetryInputCaptureInterceptor;
147
148#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
149impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListDirectoryBucketsTelemetryInputCaptureInterceptor {
150    fn name(&self) -> &'static str {
151        "ListDirectoryBucketsTelemetryInputCaptureInterceptor"
152    }
153
154    fn read_before_execution(
155        &self,
156        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
157            '_,
158            ::aws_smithy_runtime_api::client::interceptors::context::Input,
159            ::aws_smithy_runtime_api::client::interceptors::context::Output,
160            ::aws_smithy_runtime_api::client::interceptors::context::Error,
161        >,
162        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
163    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
164        // Nothing to do unless the customer opted in by naming members to record.
165        let ::std::option::Option::Some(requested) = cfg
166            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
167            .filter(|r| !r.is_empty())
168        else {
169            return ::std::result::Result::Ok(());
170        };
171
172        let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListDirectoryBucketsInput>() else {
173            // A mismatched input is not this interceptor's concern; skip quietly.
174            return ::std::result::Result::Ok(());
175        };
176
177        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
178        if requested.should_capture("ContinuationToken") {
179            if let ::std::option::Option::Some(value) = input.continuation_token.as_deref() {
180                captured.insert("ContinuationToken", value);
181            }
182        }
183
184        cfg.interceptor_state().store_put(captured);
185        ::std::result::Result::Ok(())
186    }
187}
188#[derive(Debug)]
189struct ListDirectoryBucketsResponseDeserializer;
190impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListDirectoryBucketsResponseDeserializer {
191    fn deserialize_nonstreaming_with_config(
192        &self,
193        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
194        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
195    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
196        let (success, status) = (response.status().is_success(), response.status().as_u16());
197        let headers = response.headers();
198        let body = response.body().bytes().expect("body loaded");
199        #[allow(unused_mut)]
200        let mut force_error = false;
201        ::tracing::debug!(extended_request_id = ?crate::s3_request_id::RequestIdExt::extended_request_id(response));
202        if matches!(crate::rest_xml_unwrapped_errors::body_is_error(body), Ok(true)) {
203            force_error = true;
204        }
205        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
206        let parse_result = if !success && status != 200 || force_error {
207            crate::protocol_serde::shape_list_directory_buckets::de_list_directory_buckets_http_error(status, headers, body, _cfg)
208        } else {
209            crate::protocol_serde::shape_list_directory_buckets::de_list_directory_buckets_http_response(status, headers, body, _cfg)
210        };
211        crate::protocol_serde::type_erase_result(parse_result)
212    }
213}
214#[derive(Debug)]
215struct ListDirectoryBucketsRequestSerializer;
216impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListDirectoryBucketsRequestSerializer {
217    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
218    fn serialize_input(
219        &self,
220        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
221        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
222    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
223        let input = input
224            .downcast::<crate::operation::list_directory_buckets::ListDirectoryBucketsInput>()
225            .expect("correct type");
226        let _header_serialization_settings = _cfg
227            .load::<crate::serialization_settings::HeaderSerializationSettings>()
228            .cloned()
229            .unwrap_or_default();
230        let mut request_builder = {
231            #[allow(clippy::uninlined_format_args)]
232            fn uri_base(
233                _input: &crate::operation::list_directory_buckets::ListDirectoryBucketsInput,
234                output: &mut ::std::string::String,
235            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
236                use ::std::fmt::Write as _;
237                ::std::write!(output, "/").expect("formatting should succeed");
238                ::std::result::Result::Ok(())
239            }
240            fn uri_query(
241                _input: &crate::operation::list_directory_buckets::ListDirectoryBucketsInput,
242                mut output: &mut ::std::string::String,
243            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
244                let mut query = ::aws_smithy_http::query::Writer::new(output);
245                query.push_kv("x-id", "ListDirectoryBuckets");
246                if let ::std::option::Option::Some(inner_1) = &_input.continuation_token {
247                    {
248                        query.push_kv("continuation-token", &::aws_smithy_http::query::fmt_string(inner_1));
249                    }
250                }
251                if let ::std::option::Option::Some(inner_2) = &_input.max_directory_buckets {
252                    {
253                        query.push_kv("max-directory-buckets", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
254                    }
255                }
256                ::std::result::Result::Ok(())
257            }
258            #[allow(clippy::unnecessary_wraps)]
259            fn update_http_builder(
260                input: &crate::operation::list_directory_buckets::ListDirectoryBucketsInput,
261                builder: ::http_1x::request::Builder,
262            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
263                let mut uri = ::std::string::String::new();
264                uri_base(input, &mut uri)?;
265                uri_query(input, &mut uri)?;
266                ::std::result::Result::Ok(builder.method("GET").uri(uri))
267            }
268            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
269            builder
270        };
271        let body = ::aws_smithy_types::body::SdkBody::from("");
272
273        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
274    }
275}
276#[derive(Debug)]
277struct ListDirectoryBucketsEndpointParamsInterceptor;
278
279#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
280impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListDirectoryBucketsEndpointParamsInterceptor {
281    fn name(&self) -> &'static str {
282        "ListDirectoryBucketsEndpointParamsInterceptor"
283    }
284
285    fn read_before_execution(
286        &self,
287        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
288            '_,
289            ::aws_smithy_runtime_api::client::interceptors::context::Input,
290            ::aws_smithy_runtime_api::client::interceptors::context::Output,
291            ::aws_smithy_runtime_api::client::interceptors::context::Error,
292        >,
293        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
294    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
295        let _input = context
296            .input()
297            .downcast_ref::<ListDirectoryBucketsInput>()
298            .ok_or("failed to downcast to ListDirectoryBucketsInput")?;
299
300        let params = crate::config::endpoint::Params::builder()
301            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
302            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
303            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
304            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
305            .set_force_path_style(cfg.load::<crate::config::ForcePathStyle>().map(|ty| ty.0))
306            .set_use_arn_region(cfg.load::<crate::config::UseArnRegion>().map(|ty| ty.0))
307            .set_disable_multi_region_access_points(cfg.load::<crate::config::DisableMultiRegionAccessPoints>().map(|ty| ty.0))
308            .set_accelerate(cfg.load::<crate::config::Accelerate>().map(|ty| ty.0))
309            .set_disable_s3_express_session_auth(cfg.load::<crate::config::DisableS3ExpressSessionAuth>().map(|ty| ty.0))
310            .set_use_s3_express_control_endpoint(Some(true))
311            .build()
312            .map_err(|err| {
313                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
314            })?;
315        cfg.interceptor_state()
316            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
317        ::std::result::Result::Ok(())
318    }
319}
320
321// The get_* functions below are generated from JMESPath expressions in the
322// operationContextParams trait. They target the operation's input shape.
323
324/// Error type for the `ListDirectoryBucketsError` operation.
325#[non_exhaustive]
326#[derive(::std::fmt::Debug)]
327pub enum ListDirectoryBucketsError {
328    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
329    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
330    variable wildcard pattern and check `.code()`:
331     \
332    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
333     \
334    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListDirectoryBucketsError) for what information is available for the error.")]
335    Unhandled(crate::error::sealed_unhandled::Unhandled),
336}
337impl ListDirectoryBucketsError {
338    /// Creates the `ListDirectoryBucketsError::Unhandled` variant from any error type.
339    pub fn unhandled(
340        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
341    ) -> Self {
342        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
343            source: err.into(),
344            meta: ::std::default::Default::default(),
345        })
346    }
347
348    /// Creates the `ListDirectoryBucketsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
349    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
350        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
351            source: err.clone().into(),
352            meta: err,
353        })
354    }
355    ///
356    /// Returns error metadata, which includes the error code, message,
357    /// request ID, and potentially additional information.
358    ///
359    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
360        match self {
361            Self::Unhandled(e) => &e.meta,
362        }
363    }
364}
365impl ::std::error::Error for ListDirectoryBucketsError {
366    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
367        match self {
368            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
369        }
370    }
371}
372impl ::std::fmt::Display for ListDirectoryBucketsError {
373    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
374        match self {
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 ListDirectoryBucketsError {
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 ListDirectoryBucketsError {
394    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
395        match self {
396            Self::Unhandled(_inner) => &_inner.meta,
397        }
398    }
399}
400impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListDirectoryBucketsError {
401    fn create_unhandled_error(
402        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
403        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
404    ) -> Self {
405        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
406            source,
407            meta: meta.unwrap_or_default(),
408        })
409    }
410}
411impl crate::s3_request_id::RequestIdExt for crate::operation::list_directory_buckets::ListDirectoryBucketsError {
412    fn extended_request_id(&self) -> Option<&str> {
413        self.meta().extended_request_id()
414    }
415}
416impl ::aws_types::request_id::RequestId for crate::operation::list_directory_buckets::ListDirectoryBucketsError {
417    fn request_id(&self) -> Option<&str> {
418        self.meta().request_id()
419    }
420}
421
422pub use crate::operation::list_directory_buckets::_list_directory_buckets_input::ListDirectoryBucketsInput;
423
424pub use crate::operation::list_directory_buckets::_list_directory_buckets_output::ListDirectoryBucketsOutput;
425
426mod _list_directory_buckets_input;
427
428mod _list_directory_buckets_output;
429
430/// Builders
431pub mod builders;
432
433/// Paginator for this operation
434pub mod paginator;
aws_sdk_s3/operation/list_directory_buckets.rs

aws_sdk_s3/operation/
list_directory_buckets.rs
