aws_sdk_backup/operation/
list_backup_jobs.rs

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

aws_sdk_backup/operation/
list_backup_jobs.rs
