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

aws_sdk_backup/operation/
list_backup_jobs.rs
