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

aws_sdk_backup/operation/
list_backup_jobs.rs
