aws_sdk_backup/operation/
stop_backup_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StopBackupJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StopBackupJob;
6impl StopBackupJob {
7    /// Creates a new `StopBackupJob`
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_backup_job::StopBackupJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::stop_backup_job::StopBackupJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::stop_backup_job::StopBackupJobError,
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_backup_job::StopBackupJobError>()
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_backup_job::StopBackupJobOutput>()
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_backup_job::StopBackupJobInput,
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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("backup", "StopBackupJob", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for StopBackupJob {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StopBackupJob");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            StopBackupJobRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            StopBackupJobResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StopBackupJob", "backup"));
94        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
95        signing_options.double_uri_encode = true;
96        signing_options.content_sha256_header = false;
97        signing_options.normalize_uri_path = true;
98        signing_options.payload_override = None;
99
100        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
101            signing_options,
102            ..::std::default::Default::default()
103        });
104
105        ::std::option::Option::Some(cfg.freeze())
106    }
107
108    fn runtime_components(
109        &self,
110        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
111    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
112        #[allow(unused_mut)]
113        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StopBackupJob")
114            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
115            .with_interceptor(StopBackupJobEndpointParamsInterceptor)
116            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
117                crate::operation::stop_backup_job::StopBackupJobError,
118            >::new())
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
120                crate::operation::stop_backup_job::StopBackupJobError,
121            >::new())
122            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
123                crate::operation::stop_backup_job::StopBackupJobError,
124            >::new());
125
126        ::std::borrow::Cow::Owned(rcb)
127    }
128}
129
130#[derive(Debug)]
131struct StopBackupJobResponseDeserializer;
132impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StopBackupJobResponseDeserializer {
133    fn deserialize_nonstreaming(
134        &self,
135        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
136    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
137        let (success, status) = (response.status().is_success(), response.status().as_u16());
138        let headers = response.headers();
139        let body = response.body().bytes().expect("body loaded");
140        #[allow(unused_mut)]
141        let mut force_error = false;
142        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
143        let parse_result = if !success && status != 200 || force_error {
144            crate::protocol_serde::shape_stop_backup_job::de_stop_backup_job_http_error(status, headers, body)
145        } else {
146            crate::protocol_serde::shape_stop_backup_job::de_stop_backup_job_http_response(status, headers, body)
147        };
148        crate::protocol_serde::type_erase_result(parse_result)
149    }
150}
151#[derive(Debug)]
152struct StopBackupJobRequestSerializer;
153impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StopBackupJobRequestSerializer {
154    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
155    fn serialize_input(
156        &self,
157        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
158        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
159    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
160        let input = input
161            .downcast::<crate::operation::stop_backup_job::StopBackupJobInput>()
162            .expect("correct type");
163        let _header_serialization_settings = _cfg
164            .load::<crate::serialization_settings::HeaderSerializationSettings>()
165            .cloned()
166            .unwrap_or_default();
167        let mut request_builder = {
168            fn uri_base(
169                _input: &crate::operation::stop_backup_job::StopBackupJobInput,
170                output: &mut ::std::string::String,
171            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
172                use ::std::fmt::Write as _;
173                let input_1 = &_input.backup_job_id;
174                let input_1 = input_1
175                    .as_ref()
176                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("backup_job_id", "cannot be empty or unset"))?;
177                let backup_job_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
178                if backup_job_id.is_empty() {
179                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
180                        "backup_job_id",
181                        "cannot be empty or unset",
182                    ));
183                }
184                ::std::write!(output, "/backup-jobs/{BackupJobId}", BackupJobId = backup_job_id).expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            #[allow(clippy::unnecessary_wraps)]
188            fn update_http_builder(
189                input: &crate::operation::stop_backup_job::StopBackupJobInput,
190                builder: ::http::request::Builder,
191            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
192                let mut uri = ::std::string::String::new();
193                uri_base(input, &mut uri)?;
194                ::std::result::Result::Ok(builder.method("POST").uri(uri))
195            }
196            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
197            builder
198        };
199        let body = ::aws_smithy_types::body::SdkBody::from("");
200
201        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
202    }
203}
204#[derive(Debug)]
205struct StopBackupJobEndpointParamsInterceptor;
206
207impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopBackupJobEndpointParamsInterceptor {
208    fn name(&self) -> &'static str {
209        "StopBackupJobEndpointParamsInterceptor"
210    }
211
212    fn read_before_execution(
213        &self,
214        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
215            '_,
216            ::aws_smithy_runtime_api::client::interceptors::context::Input,
217            ::aws_smithy_runtime_api::client::interceptors::context::Output,
218            ::aws_smithy_runtime_api::client::interceptors::context::Error,
219        >,
220        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
221    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
222        let _input = context
223            .input()
224            .downcast_ref::<StopBackupJobInput>()
225            .ok_or("failed to downcast to StopBackupJobInput")?;
226
227        let params = crate::config::endpoint::Params::builder()
228            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
229            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
230            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
231            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
232            .build()
233            .map_err(|err| {
234                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
235            })?;
236        cfg.interceptor_state()
237            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
238        ::std::result::Result::Ok(())
239    }
240}
241
242// The get_* functions below are generated from JMESPath expressions in the
243// operationContextParams trait. They target the operation's input shape.
244
245/// Error type for the `StopBackupJobError` operation.
246#[non_exhaustive]
247#[derive(::std::fmt::Debug)]
248pub enum StopBackupJobError {
249    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
250    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
251    /// <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
252    InvalidRequestException(crate::types::error::InvalidRequestException),
253    /// <p>Indicates that a required parameter is missing.</p>
254    MissingParameterValueException(crate::types::error::MissingParameterValueException),
255    /// <p>A resource that is required for the action doesn't exist.</p>
256    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
257    /// <p>The request failed due to a temporary failure of the server.</p>
258    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
259    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
260    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
261    variable wildcard pattern and check `.code()`:
262     \
263    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
264     \
265    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StopBackupJobError) for what information is available for the error.")]
266    Unhandled(crate::error::sealed_unhandled::Unhandled),
267}
268impl StopBackupJobError {
269    /// Creates the `StopBackupJobError::Unhandled` variant from any error type.
270    pub fn unhandled(
271        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
272    ) -> Self {
273        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
274            source: err.into(),
275            meta: ::std::default::Default::default(),
276        })
277    }
278
279    /// Creates the `StopBackupJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
280    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
281        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
282            source: err.clone().into(),
283            meta: err,
284        })
285    }
286    ///
287    /// Returns error metadata, which includes the error code, message,
288    /// request ID, and potentially additional information.
289    ///
290    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
291        match self {
292            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
293            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
294            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
295            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::Unhandled(e) => &e.meta,
298        }
299    }
300    /// Returns `true` if the error kind is `StopBackupJobError::InvalidParameterValueException`.
301    pub fn is_invalid_parameter_value_exception(&self) -> bool {
302        matches!(self, Self::InvalidParameterValueException(_))
303    }
304    /// Returns `true` if the error kind is `StopBackupJobError::InvalidRequestException`.
305    pub fn is_invalid_request_exception(&self) -> bool {
306        matches!(self, Self::InvalidRequestException(_))
307    }
308    /// Returns `true` if the error kind is `StopBackupJobError::MissingParameterValueException`.
309    pub fn is_missing_parameter_value_exception(&self) -> bool {
310        matches!(self, Self::MissingParameterValueException(_))
311    }
312    /// Returns `true` if the error kind is `StopBackupJobError::ResourceNotFoundException`.
313    pub fn is_resource_not_found_exception(&self) -> bool {
314        matches!(self, Self::ResourceNotFoundException(_))
315    }
316    /// Returns `true` if the error kind is `StopBackupJobError::ServiceUnavailableException`.
317    pub fn is_service_unavailable_exception(&self) -> bool {
318        matches!(self, Self::ServiceUnavailableException(_))
319    }
320}
321impl ::std::error::Error for StopBackupJobError {
322    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
323        match self {
324            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
325            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
326            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
327            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
328            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
329            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
330        }
331    }
332}
333impl ::std::fmt::Display for StopBackupJobError {
334    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
335        match self {
336            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
337            Self::InvalidRequestException(_inner) => _inner.fmt(f),
338            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
339            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
340            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
341            Self::Unhandled(_inner) => {
342                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
343                    write!(f, "unhandled error ({code})")
344                } else {
345                    f.write_str("unhandled error")
346                }
347            }
348        }
349    }
350}
351impl ::aws_smithy_types::retry::ProvideErrorKind for StopBackupJobError {
352    fn code(&self) -> ::std::option::Option<&str> {
353        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
354    }
355    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
356        ::std::option::Option::None
357    }
358}
359impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StopBackupJobError {
360    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
361        match self {
362            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
363            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
364            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
365            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
366            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
367            Self::Unhandled(_inner) => &_inner.meta,
368        }
369    }
370}
371impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StopBackupJobError {
372    fn create_unhandled_error(
373        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
374        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
375    ) -> Self {
376        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
377            source,
378            meta: meta.unwrap_or_default(),
379        })
380    }
381}
382impl ::aws_types::request_id::RequestId for crate::operation::stop_backup_job::StopBackupJobError {
383    fn request_id(&self) -> Option<&str> {
384        self.meta().request_id()
385    }
386}
387
388pub use crate::operation::stop_backup_job::_stop_backup_job_output::StopBackupJobOutput;
389
390pub use crate::operation::stop_backup_job::_stop_backup_job_input::StopBackupJobInput;
391
392mod _stop_backup_job_input;
393
394mod _stop_backup_job_output;
395
396/// Builders
397pub mod builders;
aws_sdk_backup/operation/stop_backup_job.rs

aws_sdk_backup/operation/
stop_backup_job.rs
