aws_sdk_rds/operation/
stop_db_instance.rs

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

aws_sdk_rds/operation/
stop_db_instance.rs
