Skip to main content

aws_sdk_rds/operation/
describe_db_cluster_snapshots.rs

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