aws_sdk_backup/operation/
list_scan_jobs.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListScanJobs`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListScanJobs;
6impl ListScanJobs {
7    /// Creates a new `ListScanJobs`
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_scan_jobs::ListScanJobsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_scan_jobs::ListScanJobsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_scan_jobs::ListScanJobsError,
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_scan_jobs::ListScanJobsError>()
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_scan_jobs::ListScanJobsOutput>()
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_scan_jobs::ListScanJobsInput,
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", "ListScanJobs", 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.ListScanJobs",
59                "rpc.service" = "Backup",
60                "rpc.method" = "ListScanJobs",
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 ListScanJobs {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListScanJobs");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListScanJobsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListScanJobsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListScanJobs")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListScanJobs", "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("ListScanJobs")
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                ListScanJobsEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::list_scan_jobs::ListScanJobsError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::list_scan_jobs::ListScanJobsError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::list_scan_jobs::ListScanJobsError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct ListScanJobsResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListScanJobsResponseDeserializer {
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_scan_jobs::de_list_scan_jobs_http_error(status, headers, body)
162        } else {
163            crate::protocol_serde::shape_list_scan_jobs::de_list_scan_jobs_http_response(status, headers, body)
164        };
165        crate::protocol_serde::type_erase_result(parse_result)
166    }
167}
168#[derive(Debug)]
169struct ListScanJobsRequestSerializer;
170impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListScanJobsRequestSerializer {
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_scan_jobs::ListScanJobsInput>()
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_scan_jobs::ListScanJobsInput,
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, "/scan/jobs").expect("formatting should succeed");
192                ::std::result::Result::Ok(())
193            }
194            fn uri_query(
195                _input: &crate::operation::list_scan_jobs::ListScanJobsInput,
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.by_account_id {
200                    {
201                        query.push_kv("ByAccountId", &::aws_smithy_http::query::fmt_string(inner_1));
202                    }
203                }
204                if let ::std::option::Option::Some(inner_2) = &_input.by_backup_vault_name {
205                    {
206                        query.push_kv("ByBackupVaultName", &::aws_smithy_http::query::fmt_string(inner_2));
207                    }
208                }
209                if let ::std::option::Option::Some(inner_3) = &_input.by_complete_after {
210                    {
211                        query.push_kv(
212                            "ByCompleteAfter",
213                            &::aws_smithy_http::query::fmt_timestamp(inner_3, ::aws_smithy_types::date_time::Format::DateTime)?,
214                        );
215                    }
216                }
217                if let ::std::option::Option::Some(inner_4) = &_input.by_complete_before {
218                    {
219                        query.push_kv(
220                            "ByCompleteBefore",
221                            &::aws_smithy_http::query::fmt_timestamp(inner_4, ::aws_smithy_types::date_time::Format::DateTime)?,
222                        );
223                    }
224                }
225                if let ::std::option::Option::Some(inner_5) = &_input.by_malware_scanner {
226                    {
227                        query.push_kv("ByMalwareScanner", &::aws_smithy_http::query::fmt_string(inner_5.as_str()));
228                    }
229                }
230                if let ::std::option::Option::Some(inner_6) = &_input.by_recovery_point_arn {
231                    {
232                        query.push_kv("ByRecoveryPointArn", &::aws_smithy_http::query::fmt_string(inner_6));
233                    }
234                }
235                if let ::std::option::Option::Some(inner_7) = &_input.by_resource_arn {
236                    {
237                        query.push_kv("ByResourceArn", &::aws_smithy_http::query::fmt_string(inner_7));
238                    }
239                }
240                if let ::std::option::Option::Some(inner_8) = &_input.by_resource_type {
241                    {
242                        query.push_kv("ByResourceType", &::aws_smithy_http::query::fmt_string(inner_8.as_str()));
243                    }
244                }
245                if let ::std::option::Option::Some(inner_9) = &_input.by_scan_result_status {
246                    {
247                        query.push_kv("ByScanResultStatus", &::aws_smithy_http::query::fmt_string(inner_9.as_str()));
248                    }
249                }
250                if let ::std::option::Option::Some(inner_10) = &_input.by_state {
251                    {
252                        query.push_kv("ByState", &::aws_smithy_http::query::fmt_string(inner_10.as_str()));
253                    }
254                }
255                if let ::std::option::Option::Some(inner_11) = &_input.max_results {
256                    {
257                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_11).encode());
258                    }
259                }
260                if let ::std::option::Option::Some(inner_12) = &_input.next_token {
261                    {
262                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_12));
263                    }
264                }
265                ::std::result::Result::Ok(())
266            }
267            #[allow(clippy::unnecessary_wraps)]
268            fn update_http_builder(
269                input: &crate::operation::list_scan_jobs::ListScanJobsInput,
270                builder: ::http_1x::request::Builder,
271            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
272                let mut uri = ::std::string::String::new();
273                uri_base(input, &mut uri)?;
274                uri_query(input, &mut uri)?;
275                ::std::result::Result::Ok(builder.method("GET").uri(uri))
276            }
277            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
278            builder
279        };
280        let body = ::aws_smithy_types::body::SdkBody::from("");
281
282        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
283    }
284}
285#[derive(Debug)]
286struct ListScanJobsEndpointParamsInterceptor;
287
288#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
289impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListScanJobsEndpointParamsInterceptor {
290    fn name(&self) -> &'static str {
291        "ListScanJobsEndpointParamsInterceptor"
292    }
293
294    fn read_before_execution(
295        &self,
296        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
297            '_,
298            ::aws_smithy_runtime_api::client::interceptors::context::Input,
299            ::aws_smithy_runtime_api::client::interceptors::context::Output,
300            ::aws_smithy_runtime_api::client::interceptors::context::Error,
301        >,
302        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
303    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
304        let _input = context
305            .input()
306            .downcast_ref::<ListScanJobsInput>()
307            .ok_or("failed to downcast to ListScanJobsInput")?;
308
309        let params = crate::config::endpoint::Params::builder()
310            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
311            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
312            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
313            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
314            .build()
315            .map_err(|err| {
316                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
317            })?;
318        cfg.interceptor_state()
319            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
320        ::std::result::Result::Ok(())
321    }
322}
323
324// The get_* functions below are generated from JMESPath expressions in the
325// operationContextParams trait. They target the operation's input shape.
326
327/// Error type for the `ListScanJobsError` operation.
328#[non_exhaustive]
329#[derive(::std::fmt::Debug)]
330pub enum ListScanJobsError {
331    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
332    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
333    /// <p>The request failed due to a temporary failure of the server.</p>
334    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
335    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
336    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
337    variable wildcard pattern and check `.code()`:
338     \
339    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
340     \
341    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListScanJobsError) for what information is available for the error.")]
342    Unhandled(crate::error::sealed_unhandled::Unhandled),
343}
344impl ListScanJobsError {
345    /// Creates the `ListScanJobsError::Unhandled` variant from any error type.
346    pub fn unhandled(
347        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
348    ) -> Self {
349        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
350            source: err.into(),
351            meta: ::std::default::Default::default(),
352        })
353    }
354
355    /// Creates the `ListScanJobsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
356    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
357        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
358            source: err.clone().into(),
359            meta: err,
360        })
361    }
362    ///
363    /// Returns error metadata, which includes the error code, message,
364    /// request ID, and potentially additional information.
365    ///
366    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
367        match self {
368            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
369            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
370            Self::Unhandled(e) => &e.meta,
371        }
372    }
373    /// Returns `true` if the error kind is `ListScanJobsError::InvalidParameterValueException`.
374    pub fn is_invalid_parameter_value_exception(&self) -> bool {
375        matches!(self, Self::InvalidParameterValueException(_))
376    }
377    /// Returns `true` if the error kind is `ListScanJobsError::ServiceUnavailableException`.
378    pub fn is_service_unavailable_exception(&self) -> bool {
379        matches!(self, Self::ServiceUnavailableException(_))
380    }
381}
382impl ::std::error::Error for ListScanJobsError {
383    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
384        match self {
385            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
386            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
387            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
388        }
389    }
390}
391impl ::std::fmt::Display for ListScanJobsError {
392    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
393        match self {
394            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
395            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
396            Self::Unhandled(_inner) => {
397                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
398                    write!(f, "unhandled error ({code})")
399                } else {
400                    f.write_str("unhandled error")
401                }
402            }
403        }
404    }
405}
406impl ::aws_smithy_types::retry::ProvideErrorKind for ListScanJobsError {
407    fn code(&self) -> ::std::option::Option<&str> {
408        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
409    }
410    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
411        ::std::option::Option::None
412    }
413}
414impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListScanJobsError {
415    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
416        match self {
417            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::Unhandled(_inner) => &_inner.meta,
420        }
421    }
422}
423impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListScanJobsError {
424    fn create_unhandled_error(
425        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
426        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
427    ) -> Self {
428        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
429            source,
430            meta: meta.unwrap_or_default(),
431        })
432    }
433}
434impl ::aws_types::request_id::RequestId for crate::operation::list_scan_jobs::ListScanJobsError {
435    fn request_id(&self) -> Option<&str> {
436        self.meta().request_id()
437    }
438}
439
440pub use crate::operation::list_scan_jobs::_list_scan_jobs_input::ListScanJobsInput;
441
442pub use crate::operation::list_scan_jobs::_list_scan_jobs_output::ListScanJobsOutput;
443
444mod _list_scan_jobs_input;
445
446mod _list_scan_jobs_output;
447
448/// Builders
449pub mod builders;
450
451/// Paginator for this operation
452pub mod paginator;
aws_sdk_backup/operation/list_scan_jobs.rs

aws_sdk_backup/operation/
list_scan_jobs.rs
