Skip to main content

aws_sdk_backup/operation/
list_restore_job_summaries.rs

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