aws_sdk_rds/operation/
describe_option_groups.rs

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

aws_sdk_rds/operation/
describe_option_groups.rs
