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

aws_sdk_backup/operation/
list_backup_jobs.rs
