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

aws_sdk_backup/operation/
list_backup_job_summaries.rs
