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

aws_sdk_backup/operation/
list_backup_job_summaries.rs
