aws_sdk_docdb/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("DocDB", "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                "DocDB.DescribeDBClusterSnapshots",
59                "rpc.service" = "DocDB",
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            "DocDB",
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
206        cfg.interceptor_state().store_put(captured);
207        ::std::result::Result::Ok(())
208    }
209}
210#[derive(Debug)]
211struct DescribeDBClusterSnapshotsResponseDeserializer;
212impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeDBClusterSnapshotsResponseDeserializer {
213    fn deserialize_nonstreaming_with_config(
214        &self,
215        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
216        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
217    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
218        let (success, status) = (response.status().is_success(), response.status().as_u16());
219        let headers = response.headers();
220        let body = response.body().bytes().expect("body loaded");
221        #[allow(unused_mut)]
222        let mut force_error = false;
223        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
224        let parse_result = if !success && status != 200 || force_error {
225            crate::protocol_serde::shape_describe_db_cluster_snapshots::de_describe_db_cluster_snapshots_http_error(status, headers, body)
226        } else {
227            crate::protocol_serde::shape_describe_db_cluster_snapshots::de_describe_db_cluster_snapshots_http_response(status, headers, body)
228        };
229        crate::protocol_serde::type_erase_result(parse_result)
230    }
231}
232#[derive(Debug)]
233struct DescribeDBClusterSnapshotsRequestSerializer;
234impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeDBClusterSnapshotsRequestSerializer {
235    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
236    fn serialize_input(
237        &self,
238        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
239        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
240    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
241        let input = input
242            .downcast::<crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsInput>()
243            .expect("correct type");
244        let _header_serialization_settings = _cfg
245            .load::<crate::serialization_settings::HeaderSerializationSettings>()
246            .cloned()
247            .unwrap_or_default();
248        let mut request_builder = {
249            #[allow(clippy::uninlined_format_args)]
250            fn uri_base(
251                _input: &crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsInput,
252                output: &mut ::std::string::String,
253            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
254                use ::std::fmt::Write as _;
255                ::std::write!(output, "/").expect("formatting should succeed");
256                ::std::result::Result::Ok(())
257            }
258            #[allow(clippy::unnecessary_wraps)]
259            fn update_http_builder(
260                input: &crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsInput,
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                ::std::result::Result::Ok(builder.method("POST").uri(uri))
266            }
267            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
268            builder =
269                _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
270            builder
271        };
272        let body = ::aws_smithy_types::body::SdkBody::from(
273            crate::protocol_serde::shape_describe_db_cluster_snapshots_input::ser_describe_db_cluster_snapshots_input_input_input(&input)?,
274        );
275        if let Some(content_length) = body.content_length() {
276            let content_length = content_length.to_string();
277            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
278        }
279        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
280    }
281}
282#[derive(Debug)]
283struct DescribeDBClusterSnapshotsEndpointParamsInterceptor;
284
285#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
286impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeDBClusterSnapshotsEndpointParamsInterceptor {
287    fn name(&self) -> &'static str {
288        "DescribeDBClusterSnapshotsEndpointParamsInterceptor"
289    }
290
291    fn read_before_execution(
292        &self,
293        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
294            '_,
295            ::aws_smithy_runtime_api::client::interceptors::context::Input,
296            ::aws_smithy_runtime_api::client::interceptors::context::Output,
297            ::aws_smithy_runtime_api::client::interceptors::context::Error,
298        >,
299        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
300    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
301        let _input = context
302            .input()
303            .downcast_ref::<DescribeDbClusterSnapshotsInput>()
304            .ok_or("failed to downcast to DescribeDbClusterSnapshotsInput")?;
305
306        let params = crate::config::endpoint::Params::builder()
307            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
308            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
309            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
310            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
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 `DescribeDBClusterSnapshotsError` operation.
325#[non_exhaustive]
326#[derive(::std::fmt::Debug)]
327pub enum DescribeDBClusterSnapshotsError {
328    /// <p><code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot.</p>
329    DbClusterSnapshotNotFoundFault(crate::types::error::DbClusterSnapshotNotFoundFault),
330    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
331    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
332    variable wildcard pattern and check `.code()`:
333     \
334    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
335     \
336    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeDBClusterSnapshotsError) for what information is available for the error.")]
337    Unhandled(crate::error::sealed_unhandled::Unhandled),
338}
339impl DescribeDBClusterSnapshotsError {
340    /// Creates the `DescribeDBClusterSnapshotsError::Unhandled` variant from any error type.
341    pub fn unhandled(
342        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
343    ) -> Self {
344        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
345            source: err.into(),
346            meta: ::std::default::Default::default(),
347        })
348    }
349
350    /// Creates the `DescribeDBClusterSnapshotsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
351    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
352        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
353            source: err.clone().into(),
354            meta: err,
355        })
356    }
357    ///
358    /// Returns error metadata, which includes the error code, message,
359    /// request ID, and potentially additional information.
360    ///
361    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
362        match self {
363            Self::DbClusterSnapshotNotFoundFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
364            Self::Unhandled(e) => &e.meta,
365        }
366    }
367    /// Returns `true` if the error kind is `DescribeDBClusterSnapshotsError::DbClusterSnapshotNotFoundFault`.
368    pub fn is_db_cluster_snapshot_not_found_fault(&self) -> bool {
369        matches!(self, Self::DbClusterSnapshotNotFoundFault(_))
370    }
371}
372impl ::std::error::Error for DescribeDBClusterSnapshotsError {
373    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
374        match self {
375            Self::DbClusterSnapshotNotFoundFault(_inner) => ::std::option::Option::Some(_inner),
376            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
377        }
378    }
379}
380impl ::std::fmt::Display for DescribeDBClusterSnapshotsError {
381    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
382        match self {
383            Self::DbClusterSnapshotNotFoundFault(_inner) => _inner.fmt(f),
384            Self::Unhandled(_inner) => {
385                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
386                    write!(f, "unhandled error ({code})")
387                } else {
388                    f.write_str("unhandled error")
389                }
390            }
391        }
392    }
393}
394impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeDBClusterSnapshotsError {
395    fn code(&self) -> ::std::option::Option<&str> {
396        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
397    }
398    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
399        ::std::option::Option::None
400    }
401}
402impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeDBClusterSnapshotsError {
403    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
404        match self {
405            Self::DbClusterSnapshotNotFoundFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::Unhandled(_inner) => &_inner.meta,
407        }
408    }
409}
410impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeDBClusterSnapshotsError {
411    fn create_unhandled_error(
412        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
413        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
414    ) -> Self {
415        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
416            source,
417            meta: meta.unwrap_or_default(),
418        })
419    }
420}
421impl ::aws_types::request_id::RequestId for crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError {
422    fn request_id(&self) -> Option<&str> {
423        self.meta().request_id()
424    }
425}
426
427pub use crate::operation::describe_db_cluster_snapshots::_describe_db_cluster_snapshots_input::DescribeDbClusterSnapshotsInput;
428
429pub use crate::operation::describe_db_cluster_snapshots::_describe_db_cluster_snapshots_output::DescribeDbClusterSnapshotsOutput;
430
431mod _describe_db_cluster_snapshots_input;
432
433mod _describe_db_cluster_snapshots_output;
434
435/// Builders
436pub mod builders;
437
438/// Paginator for this operation
439pub mod paginator;
aws_sdk_docdb/operation/describe_db_cluster_snapshots.rs

aws_sdk_docdb/operation/
describe_db_cluster_snapshots.rs
