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

aws_sdk_backup/operation/
list_restore_job_summaries.rs
