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