aws_sdk_backup/operation/
list_restore_jobs.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListRestoreJobs`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListRestoreJobs;
6impl ListRestoreJobs {
7    /// Creates a new `ListRestoreJobs`
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::list_restore_jobs::ListRestoreJobsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_restore_jobs::ListRestoreJobsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_restore_jobs::ListRestoreJobsError,
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::list_restore_jobs::ListRestoreJobsError>()
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::list_restore_jobs::ListRestoreJobsOutput>()
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::list_restore_jobs::ListRestoreJobsInput,
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", "ListRestoreJobs", 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.ListRestoreJobs",
59                "rpc.service" = "Backup",
60                "rpc.method" = "ListRestoreJobs",
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 ListRestoreJobs {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListRestoreJobs");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListRestoreJobsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListRestoreJobsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListRestoreJobs")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListRestoreJobs", "Backup"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = true;
108        signing_options.content_sha256_header = false;
109        signing_options.normalize_uri_path = true;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListRestoreJobs")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ListRestoreJobsEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::list_restore_jobs::ListRestoreJobsError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::list_restore_jobs::ListRestoreJobsError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::list_restore_jobs::ListRestoreJobsError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct ListRestoreJobsResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListRestoreJobsResponseDeserializer {
149    fn deserialize_nonstreaming_with_config(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
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_list_restore_jobs::de_list_restore_jobs_http_error(status, headers, body)
162        } else {
163            crate::protocol_serde::shape_list_restore_jobs::de_list_restore_jobs_http_response(status, headers, body)
164        };
165        crate::protocol_serde::type_erase_result(parse_result)
166    }
167}
168#[derive(Debug)]
169struct ListRestoreJobsRequestSerializer;
170impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListRestoreJobsRequestSerializer {
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::list_restore_jobs::ListRestoreJobsInput>()
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::list_restore_jobs::ListRestoreJobsInput,
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, "/restore-jobs").expect("formatting should succeed");
192                ::std::result::Result::Ok(())
193            }
194            fn uri_query(
195                _input: &crate::operation::list_restore_jobs::ListRestoreJobsInput,
196                mut output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                let mut query = ::aws_smithy_http::query::Writer::new(output);
199                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
200                    {
201                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_1));
202                    }
203                }
204                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
205                    {
206                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
207                    }
208                }
209                if let ::std::option::Option::Some(inner_3) = &_input.by_account_id {
210                    {
211                        query.push_kv("accountId", &::aws_smithy_http::query::fmt_string(inner_3));
212                    }
213                }
214                if let ::std::option::Option::Some(inner_4) = &_input.by_resource_type {
215                    {
216                        query.push_kv("resourceType", &::aws_smithy_http::query::fmt_string(inner_4));
217                    }
218                }
219                if let ::std::option::Option::Some(inner_5) = &_input.by_created_before {
220                    {
221                        query.push_kv(
222                            "createdBefore",
223                            &::aws_smithy_http::query::fmt_timestamp(inner_5, ::aws_smithy_types::date_time::Format::DateTime)?,
224                        );
225                    }
226                }
227                if let ::std::option::Option::Some(inner_6) = &_input.by_created_after {
228                    {
229                        query.push_kv(
230                            "createdAfter",
231                            &::aws_smithy_http::query::fmt_timestamp(inner_6, ::aws_smithy_types::date_time::Format::DateTime)?,
232                        );
233                    }
234                }
235                if let ::std::option::Option::Some(inner_7) = &_input.by_status {
236                    {
237                        query.push_kv("status", &::aws_smithy_http::query::fmt_string(inner_7.as_str()));
238                    }
239                }
240                if let ::std::option::Option::Some(inner_8) = &_input.by_complete_before {
241                    {
242                        query.push_kv(
243                            "completeBefore",
244                            &::aws_smithy_http::query::fmt_timestamp(inner_8, ::aws_smithy_types::date_time::Format::DateTime)?,
245                        );
246                    }
247                }
248                if let ::std::option::Option::Some(inner_9) = &_input.by_complete_after {
249                    {
250                        query.push_kv(
251                            "completeAfter",
252                            &::aws_smithy_http::query::fmt_timestamp(inner_9, ::aws_smithy_types::date_time::Format::DateTime)?,
253                        );
254                    }
255                }
256                if let ::std::option::Option::Some(inner_10) = &_input.by_restore_testing_plan_arn {
257                    {
258                        query.push_kv("restoreTestingPlanArn", &::aws_smithy_http::query::fmt_string(inner_10));
259                    }
260                }
261                if let ::std::option::Option::Some(inner_11) = &_input.by_parent_job_id {
262                    {
263                        query.push_kv("parentJobId", &::aws_smithy_http::query::fmt_string(inner_11));
264                    }
265                }
266                ::std::result::Result::Ok(())
267            }
268            #[allow(clippy::unnecessary_wraps)]
269            fn update_http_builder(
270                input: &crate::operation::list_restore_jobs::ListRestoreJobsInput,
271                builder: ::http_1x::request::Builder,
272            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
273                let mut uri = ::std::string::String::new();
274                uri_base(input, &mut uri)?;
275                uri_query(input, &mut uri)?;
276                ::std::result::Result::Ok(builder.method("GET").uri(uri))
277            }
278            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
279            builder
280        };
281        let body = ::aws_smithy_types::body::SdkBody::from("");
282
283        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
284    }
285}
286#[derive(Debug)]
287struct ListRestoreJobsEndpointParamsInterceptor;
288
289#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
290impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListRestoreJobsEndpointParamsInterceptor {
291    fn name(&self) -> &'static str {
292        "ListRestoreJobsEndpointParamsInterceptor"
293    }
294
295    fn read_before_execution(
296        &self,
297        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
298            '_,
299            ::aws_smithy_runtime_api::client::interceptors::context::Input,
300            ::aws_smithy_runtime_api::client::interceptors::context::Output,
301            ::aws_smithy_runtime_api::client::interceptors::context::Error,
302        >,
303        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
304    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
305        let _input = context
306            .input()
307            .downcast_ref::<ListRestoreJobsInput>()
308            .ok_or("failed to downcast to ListRestoreJobsInput")?;
309
310        let params = crate::config::endpoint::Params::builder()
311            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
312            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
313            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
314            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
315            .build()
316            .map_err(|err| {
317                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
318            })?;
319        cfg.interceptor_state()
320            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
321        ::std::result::Result::Ok(())
322    }
323}
324
325// The get_* functions below are generated from JMESPath expressions in the
326// operationContextParams trait. They target the operation's input shape.
327
328/// Error type for the `ListRestoreJobsError` operation.
329#[non_exhaustive]
330#[derive(::std::fmt::Debug)]
331pub enum ListRestoreJobsError {
332    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
333    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
334    /// <p>Indicates that a required parameter is missing.</p>
335    MissingParameterValueException(crate::types::error::MissingParameterValueException),
336    /// <p>A resource that is required for the action doesn't exist.</p>
337    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
338    /// <p>The request failed due to a temporary failure of the server.</p>
339    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
340    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
341    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
342    variable wildcard pattern and check `.code()`:
343     \
344    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
345     \
346    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListRestoreJobsError) for what information is available for the error.")]
347    Unhandled(crate::error::sealed_unhandled::Unhandled),
348}
349impl ListRestoreJobsError {
350    /// Creates the `ListRestoreJobsError::Unhandled` variant from any error type.
351    pub fn unhandled(
352        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
353    ) -> Self {
354        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
355            source: err.into(),
356            meta: ::std::default::Default::default(),
357        })
358    }
359
360    /// Creates the `ListRestoreJobsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
361    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
362        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
363            source: err.clone().into(),
364            meta: err,
365        })
366    }
367    ///
368    /// Returns error metadata, which includes the error code, message,
369    /// request ID, and potentially additional information.
370    ///
371    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
372        match self {
373            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
374            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
375            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
376            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
377            Self::Unhandled(e) => &e.meta,
378        }
379    }
380    /// Returns `true` if the error kind is `ListRestoreJobsError::InvalidParameterValueException`.
381    pub fn is_invalid_parameter_value_exception(&self) -> bool {
382        matches!(self, Self::InvalidParameterValueException(_))
383    }
384    /// Returns `true` if the error kind is `ListRestoreJobsError::MissingParameterValueException`.
385    pub fn is_missing_parameter_value_exception(&self) -> bool {
386        matches!(self, Self::MissingParameterValueException(_))
387    }
388    /// Returns `true` if the error kind is `ListRestoreJobsError::ResourceNotFoundException`.
389    pub fn is_resource_not_found_exception(&self) -> bool {
390        matches!(self, Self::ResourceNotFoundException(_))
391    }
392    /// Returns `true` if the error kind is `ListRestoreJobsError::ServiceUnavailableException`.
393    pub fn is_service_unavailable_exception(&self) -> bool {
394        matches!(self, Self::ServiceUnavailableException(_))
395    }
396}
397impl ::std::error::Error for ListRestoreJobsError {
398    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
399        match self {
400            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
401            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
402            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
403            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
404            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
405        }
406    }
407}
408impl ::std::fmt::Display for ListRestoreJobsError {
409    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
410        match self {
411            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
412            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
413            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
414            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
415            Self::Unhandled(_inner) => {
416                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
417                    write!(f, "unhandled error ({code})")
418                } else {
419                    f.write_str("unhandled error")
420                }
421            }
422        }
423    }
424}
425impl ::aws_smithy_types::retry::ProvideErrorKind for ListRestoreJobsError {
426    fn code(&self) -> ::std::option::Option<&str> {
427        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
428    }
429    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
430        ::std::option::Option::None
431    }
432}
433impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListRestoreJobsError {
434    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
435        match self {
436            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
437            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
438            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
439            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
440            Self::Unhandled(_inner) => &_inner.meta,
441        }
442    }
443}
444impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListRestoreJobsError {
445    fn create_unhandled_error(
446        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
447        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
448    ) -> Self {
449        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
450            source,
451            meta: meta.unwrap_or_default(),
452        })
453    }
454}
455impl ::aws_types::request_id::RequestId for crate::operation::list_restore_jobs::ListRestoreJobsError {
456    fn request_id(&self) -> Option<&str> {
457        self.meta().request_id()
458    }
459}
460
461pub use crate::operation::list_restore_jobs::_list_restore_jobs_input::ListRestoreJobsInput;
462
463pub use crate::operation::list_restore_jobs::_list_restore_jobs_output::ListRestoreJobsOutput;
464
465mod _list_restore_jobs_input;
466
467mod _list_restore_jobs_output;
468
469/// Builders
470pub mod builders;
471
472/// Paginator for this operation
473pub mod paginator;
aws_sdk_backup/operation/list_restore_jobs.rs

aws_sdk_backup/operation/
list_restore_jobs.rs
