aws_sdk_backup/operation/
list_backup_job_summaries.rs

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

aws_sdk_backup/operation/
list_backup_job_summaries.rs
