aws_sdk_backup/operation/
start_backup_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartBackupJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartBackupJob;
6impl StartBackupJob {
7    /// Creates a new `StartBackupJob`
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::start_backup_job::StartBackupJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_backup_job::StartBackupJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_backup_job::StartBackupJobError,
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::start_backup_job::StartBackupJobError>()
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::start_backup_job::StartBackupJobOutput>()
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::start_backup_job::StartBackupJobInput,
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", "StartBackupJob", 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 StartBackupJob {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartBackupJob");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            StartBackupJobRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            StartBackupJobResponseDeserializer,
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("StartBackupJob", "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("StartBackupJob")
114            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
115            .with_interceptor(StartBackupJobEndpointParamsInterceptor)
116            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
117                crate::operation::start_backup_job::StartBackupJobError,
118            >::new())
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
120                crate::operation::start_backup_job::StartBackupJobError,
121            >::new())
122            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
123                crate::operation::start_backup_job::StartBackupJobError,
124            >::new());
125
126        ::std::borrow::Cow::Owned(rcb)
127    }
128}
129
130#[derive(Debug)]
131struct StartBackupJobResponseDeserializer;
132impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartBackupJobResponseDeserializer {
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_start_backup_job::de_start_backup_job_http_error(status, headers, body)
145        } else {
146            crate::protocol_serde::shape_start_backup_job::de_start_backup_job_http_response(status, headers, body)
147        };
148        crate::protocol_serde::type_erase_result(parse_result)
149    }
150}
151#[derive(Debug)]
152struct StartBackupJobRequestSerializer;
153impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartBackupJobRequestSerializer {
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::start_backup_job::StartBackupJobInput>()
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::start_backup_job::StartBackupJobInput,
170                output: &mut ::std::string::String,
171            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
172                use ::std::fmt::Write as _;
173                ::std::write!(output, "/backup-jobs").expect("formatting should succeed");
174                ::std::result::Result::Ok(())
175            }
176            #[allow(clippy::unnecessary_wraps)]
177            fn update_http_builder(
178                input: &crate::operation::start_backup_job::StartBackupJobInput,
179                builder: ::http::request::Builder,
180            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
181                let mut uri = ::std::string::String::new();
182                uri_base(input, &mut uri)?;
183                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
184            }
185            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
186            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
187            builder
188        };
189        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_backup_job::ser_start_backup_job_input(&input)?);
190        if let Some(content_length) = body.content_length() {
191            let content_length = content_length.to_string();
192            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
193        }
194        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
195    }
196}
197#[derive(Debug)]
198struct StartBackupJobEndpointParamsInterceptor;
199
200impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartBackupJobEndpointParamsInterceptor {
201    fn name(&self) -> &'static str {
202        "StartBackupJobEndpointParamsInterceptor"
203    }
204
205    fn read_before_execution(
206        &self,
207        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
208            '_,
209            ::aws_smithy_runtime_api::client::interceptors::context::Input,
210            ::aws_smithy_runtime_api::client::interceptors::context::Output,
211            ::aws_smithy_runtime_api::client::interceptors::context::Error,
212        >,
213        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
214    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
215        let _input = context
216            .input()
217            .downcast_ref::<StartBackupJobInput>()
218            .ok_or("failed to downcast to StartBackupJobInput")?;
219
220        let params = crate::config::endpoint::Params::builder()
221            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
222            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
223            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
224            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
225            .build()
226            .map_err(|err| {
227                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
228            })?;
229        cfg.interceptor_state()
230            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
231        ::std::result::Result::Ok(())
232    }
233}
234
235// The get_* functions below are generated from JMESPath expressions in the
236// operationContextParams trait. They target the operation's input shape.
237
238/// Error type for the `StartBackupJobError` operation.
239#[non_exhaustive]
240#[derive(::std::fmt::Debug)]
241pub enum StartBackupJobError {
242    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
243    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
244    /// <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
245    InvalidRequestException(crate::types::error::InvalidRequestException),
246    /// <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
247    LimitExceededException(crate::types::error::LimitExceededException),
248    /// <p>Indicates that a required parameter is missing.</p>
249    MissingParameterValueException(crate::types::error::MissingParameterValueException),
250    /// <p>A resource that is required for the action doesn't exist.</p>
251    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
252    /// <p>The request failed due to a temporary failure of the server.</p>
253    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
254    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
255    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
256    variable wildcard pattern and check `.code()`:
257     \
258    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
259     \
260    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartBackupJobError) for what information is available for the error.")]
261    Unhandled(crate::error::sealed_unhandled::Unhandled),
262}
263impl StartBackupJobError {
264    /// Creates the `StartBackupJobError::Unhandled` variant from any error type.
265    pub fn unhandled(
266        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
267    ) -> Self {
268        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
269            source: err.into(),
270            meta: ::std::default::Default::default(),
271        })
272    }
273
274    /// Creates the `StartBackupJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
275    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
276        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
277            source: err.clone().into(),
278            meta: err,
279        })
280    }
281    ///
282    /// Returns error metadata, which includes the error code, message,
283    /// request ID, and potentially additional information.
284    ///
285    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
286        match self {
287            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
288            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
289            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
290            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
291            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
292            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
293            Self::Unhandled(e) => &e.meta,
294        }
295    }
296    /// Returns `true` if the error kind is `StartBackupJobError::InvalidParameterValueException`.
297    pub fn is_invalid_parameter_value_exception(&self) -> bool {
298        matches!(self, Self::InvalidParameterValueException(_))
299    }
300    /// Returns `true` if the error kind is `StartBackupJobError::InvalidRequestException`.
301    pub fn is_invalid_request_exception(&self) -> bool {
302        matches!(self, Self::InvalidRequestException(_))
303    }
304    /// Returns `true` if the error kind is `StartBackupJobError::LimitExceededException`.
305    pub fn is_limit_exceeded_exception(&self) -> bool {
306        matches!(self, Self::LimitExceededException(_))
307    }
308    /// Returns `true` if the error kind is `StartBackupJobError::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 `StartBackupJobError::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 `StartBackupJobError::ServiceUnavailableException`.
317    pub fn is_service_unavailable_exception(&self) -> bool {
318        matches!(self, Self::ServiceUnavailableException(_))
319    }
320}
321impl ::std::error::Error for StartBackupJobError {
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::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
327            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
328            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
329            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
330            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
331        }
332    }
333}
334impl ::std::fmt::Display for StartBackupJobError {
335    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
336        match self {
337            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
338            Self::InvalidRequestException(_inner) => _inner.fmt(f),
339            Self::LimitExceededException(_inner) => _inner.fmt(f),
340            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
341            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
342            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
343            Self::Unhandled(_inner) => {
344                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
345                    write!(f, "unhandled error ({code})")
346                } else {
347                    f.write_str("unhandled error")
348                }
349            }
350        }
351    }
352}
353impl ::aws_smithy_types::retry::ProvideErrorKind for StartBackupJobError {
354    fn code(&self) -> ::std::option::Option<&str> {
355        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
356    }
357    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
358        ::std::option::Option::None
359    }
360}
361impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartBackupJobError {
362    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
363        match self {
364            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
365            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
366            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
367            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
368            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
369            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
370            Self::Unhandled(_inner) => &_inner.meta,
371        }
372    }
373}
374impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartBackupJobError {
375    fn create_unhandled_error(
376        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
377        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
378    ) -> Self {
379        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
380            source,
381            meta: meta.unwrap_or_default(),
382        })
383    }
384}
385impl ::aws_types::request_id::RequestId for crate::operation::start_backup_job::StartBackupJobError {
386    fn request_id(&self) -> Option<&str> {
387        self.meta().request_id()
388    }
389}
390
391pub use crate::operation::start_backup_job::_start_backup_job_output::StartBackupJobOutput;
392
393pub use crate::operation::start_backup_job::_start_backup_job_input::StartBackupJobInput;
394
395mod _start_backup_job_input;
396
397mod _start_backup_job_output;
398
399/// Builders
400pub mod builders;
aws_sdk_backup/operation/start_backup_job.rs

aws_sdk_backup/operation/
start_backup_job.rs
