aws_sdk_s3/operation/
list_buckets.rs

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

aws_sdk_s3/operation/
list_buckets.rs
