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

aws_sdk_backup/operation/
list_restore_jobs.rs
