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

aws_sdk_backup/operation/
list_backup_jobs.rs
