aws_sdk_backup/operation/
list_scan_jobs.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListScanJobs;
6impl ListScanJobs {
7 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 .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 ListScanJobsTelemetryInputCaptureInterceptor,
128 ))
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 ListScanJobsEndpointParamsInterceptor,
134 ))
135 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136 crate::operation::list_scan_jobs::ListScanJobsError,
137 >::new())
138 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139 crate::operation::list_scan_jobs::ListScanJobsError,
140 >::new())
141 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142 crate::operation::list_scan_jobs::ListScanJobsError,
143 >::new());
144
145 ::std::borrow::Cow::Owned(rcb)
146 }
147}
148
149#[derive(Debug)]
150struct ListScanJobsTelemetryInputCaptureInterceptor;
151
152#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
153impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListScanJobsTelemetryInputCaptureInterceptor {
154 fn name(&self) -> &'static str {
155 "ListScanJobsTelemetryInputCaptureInterceptor"
156 }
157
158 fn read_before_execution(
159 &self,
160 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
161 '_,
162 ::aws_smithy_runtime_api::client::interceptors::context::Input,
163 ::aws_smithy_runtime_api::client::interceptors::context::Output,
164 ::aws_smithy_runtime_api::client::interceptors::context::Error,
165 >,
166 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
168 let ::std::option::Option::Some(requested) = cfg
170 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
171 .filter(|r| !r.is_empty())
172 else {
173 return ::std::result::Result::Ok(());
174 };
175
176 let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListScanJobsInput>() else {
177 return ::std::result::Result::Ok(());
179 };
180
181 let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
182 if requested.should_capture("ByAccountId") {
183 if let ::std::option::Option::Some(value) = input.by_account_id.as_deref() {
184 captured.insert("ByAccountId", value);
185 }
186 }
187 if requested.should_capture("ByBackupVaultName") {
188 if let ::std::option::Option::Some(value) = input.by_backup_vault_name.as_deref() {
189 captured.insert("ByBackupVaultName", value);
190 }
191 }
192 if requested.should_capture("ByRecoveryPointArn") {
193 if let ::std::option::Option::Some(value) = input.by_recovery_point_arn.as_deref() {
194 captured.insert("ByRecoveryPointArn", value);
195 }
196 }
197 if requested.should_capture("ByResourceArn") {
198 if let ::std::option::Option::Some(value) = input.by_resource_arn.as_deref() {
199 captured.insert("ByResourceArn", value);
200 }
201 }
202 if requested.should_capture("NextToken") {
203 if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
204 captured.insert("NextToken", value);
205 }
206 }
207
208 cfg.interceptor_state().store_put(captured);
209 ::std::result::Result::Ok(())
210 }
211}
212#[derive(Debug)]
213struct ListScanJobsResponseDeserializer;
214impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListScanJobsResponseDeserializer {
215 fn deserialize_nonstreaming_with_config(
216 &self,
217 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
218 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
219 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
220 let (success, status) = (response.status().is_success(), response.status().as_u16());
221 let headers = response.headers();
222 let body = response.body().bytes().expect("body loaded");
223 #[allow(unused_mut)]
224 let mut force_error = false;
225 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
226 let parse_result = if !success && status != 200 || force_error {
227 crate::protocol_serde::shape_list_scan_jobs::de_list_scan_jobs_http_error(status, headers, body)
228 } else {
229 crate::protocol_serde::shape_list_scan_jobs::de_list_scan_jobs_http_response(status, headers, body)
230 };
231 crate::protocol_serde::type_erase_result(parse_result)
232 }
233}
234#[derive(Debug)]
235struct ListScanJobsRequestSerializer;
236impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListScanJobsRequestSerializer {
237 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
238 fn serialize_input(
239 &self,
240 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
241 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
242 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
243 let input = input
244 .downcast::<crate::operation::list_scan_jobs::ListScanJobsInput>()
245 .expect("correct type");
246 let _header_serialization_settings = _cfg
247 .load::<crate::serialization_settings::HeaderSerializationSettings>()
248 .cloned()
249 .unwrap_or_default();
250 let mut request_builder = {
251 #[allow(clippy::uninlined_format_args)]
252 fn uri_base(
253 _input: &crate::operation::list_scan_jobs::ListScanJobsInput,
254 output: &mut ::std::string::String,
255 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
256 use ::std::fmt::Write as _;
257 ::std::write!(output, "/scan/jobs").expect("formatting should succeed");
258 ::std::result::Result::Ok(())
259 }
260 fn uri_query(
261 _input: &crate::operation::list_scan_jobs::ListScanJobsInput,
262 mut output: &mut ::std::string::String,
263 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
264 let mut query = ::aws_smithy_http::query::Writer::new(output);
265 if let ::std::option::Option::Some(inner_1) = &_input.by_account_id {
266 {
267 query.push_kv("ByAccountId", &::aws_smithy_http::query::fmt_string(inner_1));
268 }
269 }
270 if let ::std::option::Option::Some(inner_2) = &_input.by_backup_vault_name {
271 {
272 query.push_kv("ByBackupVaultName", &::aws_smithy_http::query::fmt_string(inner_2));
273 }
274 }
275 if let ::std::option::Option::Some(inner_3) = &_input.by_complete_after {
276 {
277 query.push_kv(
278 "ByCompleteAfter",
279 &::aws_smithy_http::query::fmt_timestamp(inner_3, ::aws_smithy_types::date_time::Format::DateTime)?,
280 );
281 }
282 }
283 if let ::std::option::Option::Some(inner_4) = &_input.by_complete_before {
284 {
285 query.push_kv(
286 "ByCompleteBefore",
287 &::aws_smithy_http::query::fmt_timestamp(inner_4, ::aws_smithy_types::date_time::Format::DateTime)?,
288 );
289 }
290 }
291 if let ::std::option::Option::Some(inner_5) = &_input.by_malware_scanner {
292 {
293 query.push_kv("ByMalwareScanner", &::aws_smithy_http::query::fmt_string(inner_5.as_str()));
294 }
295 }
296 if let ::std::option::Option::Some(inner_6) = &_input.by_recovery_point_arn {
297 {
298 query.push_kv("ByRecoveryPointArn", &::aws_smithy_http::query::fmt_string(inner_6));
299 }
300 }
301 if let ::std::option::Option::Some(inner_7) = &_input.by_resource_arn {
302 {
303 query.push_kv("ByResourceArn", &::aws_smithy_http::query::fmt_string(inner_7));
304 }
305 }
306 if let ::std::option::Option::Some(inner_8) = &_input.by_resource_type {
307 {
308 query.push_kv("ByResourceType", &::aws_smithy_http::query::fmt_string(inner_8.as_str()));
309 }
310 }
311 if let ::std::option::Option::Some(inner_9) = &_input.by_scan_result_status {
312 {
313 query.push_kv("ByScanResultStatus", &::aws_smithy_http::query::fmt_string(inner_9.as_str()));
314 }
315 }
316 if let ::std::option::Option::Some(inner_10) = &_input.by_state {
317 {
318 query.push_kv("ByState", &::aws_smithy_http::query::fmt_string(inner_10.as_str()));
319 }
320 }
321 if let ::std::option::Option::Some(inner_11) = &_input.max_results {
322 {
323 query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_11).encode());
324 }
325 }
326 if let ::std::option::Option::Some(inner_12) = &_input.next_token {
327 {
328 query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_12));
329 }
330 }
331 ::std::result::Result::Ok(())
332 }
333 #[allow(clippy::unnecessary_wraps)]
334 fn update_http_builder(
335 input: &crate::operation::list_scan_jobs::ListScanJobsInput,
336 builder: ::http_1x::request::Builder,
337 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
338 let mut uri = ::std::string::String::new();
339 uri_base(input, &mut uri)?;
340 uri_query(input, &mut uri)?;
341 ::std::result::Result::Ok(builder.method("GET").uri(uri))
342 }
343 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
344 builder
345 };
346 let body = ::aws_smithy_types::body::SdkBody::from("");
347
348 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
349 }
350}
351#[derive(Debug)]
352struct ListScanJobsEndpointParamsInterceptor;
353
354#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
355impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListScanJobsEndpointParamsInterceptor {
356 fn name(&self) -> &'static str {
357 "ListScanJobsEndpointParamsInterceptor"
358 }
359
360 fn read_before_execution(
361 &self,
362 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
363 '_,
364 ::aws_smithy_runtime_api::client::interceptors::context::Input,
365 ::aws_smithy_runtime_api::client::interceptors::context::Output,
366 ::aws_smithy_runtime_api::client::interceptors::context::Error,
367 >,
368 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
369 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
370 let _input = context
371 .input()
372 .downcast_ref::<ListScanJobsInput>()
373 .ok_or("failed to downcast to ListScanJobsInput")?;
374
375 let params = crate::config::endpoint::Params::builder()
376 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
377 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
378 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
379 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
380 .build()
381 .map_err(|err| {
382 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
383 })?;
384 cfg.interceptor_state()
385 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
386 ::std::result::Result::Ok(())
387 }
388}
389
390#[non_exhaustive]
395#[derive(::std::fmt::Debug)]
396pub enum ListScanJobsError {
397 InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
399 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
401 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
403 variable wildcard pattern and check `.code()`:
404 \
405 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
406 \
407 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListScanJobsError) for what information is available for the error.")]
408 Unhandled(crate::error::sealed_unhandled::Unhandled),
409}
410impl ListScanJobsError {
411 pub fn unhandled(
413 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
414 ) -> Self {
415 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
416 source: err.into(),
417 meta: ::std::default::Default::default(),
418 })
419 }
420
421 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
423 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
424 source: err.clone().into(),
425 meta: err,
426 })
427 }
428 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
433 match self {
434 Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
435 Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
436 Self::Unhandled(e) => &e.meta,
437 }
438 }
439 pub fn is_invalid_parameter_value_exception(&self) -> bool {
441 matches!(self, Self::InvalidParameterValueException(_))
442 }
443 pub fn is_service_unavailable_exception(&self) -> bool {
445 matches!(self, Self::ServiceUnavailableException(_))
446 }
447}
448impl ::std::error::Error for ListScanJobsError {
449 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
450 match self {
451 Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
452 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
453 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
454 }
455 }
456}
457impl ::std::fmt::Display for ListScanJobsError {
458 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
459 match self {
460 Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
461 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
462 Self::Unhandled(_inner) => {
463 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
464 write!(f, "unhandled error ({code})")
465 } else {
466 f.write_str("unhandled error")
467 }
468 }
469 }
470 }
471}
472impl ::aws_smithy_types::retry::ProvideErrorKind for ListScanJobsError {
473 fn code(&self) -> ::std::option::Option<&str> {
474 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
475 }
476 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
477 ::std::option::Option::None
478 }
479}
480impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListScanJobsError {
481 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
482 match self {
483 Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
484 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
485 Self::Unhandled(_inner) => &_inner.meta,
486 }
487 }
488}
489impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListScanJobsError {
490 fn create_unhandled_error(
491 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
492 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
493 ) -> Self {
494 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
495 source,
496 meta: meta.unwrap_or_default(),
497 })
498 }
499}
500impl ::aws_types::request_id::RequestId for crate::operation::list_scan_jobs::ListScanJobsError {
501 fn request_id(&self) -> Option<&str> {
502 self.meta().request_id()
503 }
504}
505
506pub use crate::operation::list_scan_jobs::_list_scan_jobs_input::ListScanJobsInput;
507
508pub use crate::operation::list_scan_jobs::_list_scan_jobs_output::ListScanJobsOutput;
509
510mod _list_scan_jobs_input;
511
512mod _list_scan_jobs_output;
513
514pub mod builders;
516
517pub mod paginator;