aws_sdk_backup/operation/
start_restore_job.rs

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

aws_sdk_backup/operation/
start_restore_job.rs
