Skip to main content

aws_sdk_rds/operation/
describe_db_clusters.rs

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