aws_sdk_backup/operation/
list_scan_job_summaries.rs

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

aws_sdk_backup/operation/
list_scan_job_summaries.rs
